feat(api): manual updates

Author: stainless-app[bot]

.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

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

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

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<Imagekit::Models::ExtensionItem::RemoveBg, Imagekit::Models::ExtensionItem::AIAutoDescription, Imagekit::Models::ExtensionItem::AutoTaggingExtension>] Array of extensions to be applied to the asset. Each extension can be configured
-      #
-      # @param remove_ai_tags [Array<String>, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car
-      #
-      # @param tags [Array<String>, 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],

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

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

rbi/imagekit/resources/files.rbi

@@ -18,58 +18,16 @@ 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
       def update(
         # 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

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