imagekitio 4.3.0 → 4.4.0

data/lib/imagekitio/models/file.rb

@@ -5,11 +5,12 @@ module Imagekitio
     # @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.
+      #   Array of AI-generated tags associated with the image. If no AITags are set, it
+      #   will be null.
       #
-      #   @return [Array<Imagekitio::Models::File::AITag>, nil]
+      #   @return [Array<Imagekitio::Models::AITag>, nil]
       optional :ai_tags,
-               -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::File::AITag] },
+               -> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::AITag] },
                api_name: :AITags,
                nil?: true
 
@@ -134,9 +135,9 @@ module Imagekitio
       #   Keys are the names of the custom metadata fields; the value object has details
       #   about the custom metadata schema.
       #
-      #   @return [Hash{Symbol=>Imagekitio::Models::File::SelectedFieldsSchema}, nil]
+      #   @return [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}, nil]
       optional :selected_fields_schema,
-               -> { Imagekitio::Internal::Type::HashOf[Imagekitio::File::SelectedFieldsSchema] },
+               -> { Imagekitio::Internal::Type::HashOf[Imagekitio::SelectedFieldsSchemaItem] },
                api_name: :selectedFieldsSchema
 
       # @!attribute size
@@ -181,8 +182,8 @@ module Imagekitio
       # @!attribute version_info
       #   An object with details of the file version.
       #
-      #   @return [Imagekitio::Models::File::VersionInfo, nil]
-      optional :version_info, -> { Imagekitio::File::VersionInfo }, api_name: :versionInfo
+      #   @return [Imagekitio::Models::VersionInfo, nil]
+      optional :version_info, -> { Imagekitio::VersionInfo }, api_name: :versionInfo
 
       # @!attribute video_codec
       #   The video codec used in the video (only for video).
@@ -202,7 +203,7 @@ module Imagekitio
       #
       #   Object containing details of a file or file version.
       #
-      #   @param ai_tags [Array<Imagekitio::Models::File::AITag>, nil] An array of tags assigned to the file by auto tagging.
+      #   @param ai_tags [Array<Imagekitio::Models::AITag>, nil] Array of AI-generated tags associated with the image. If no AITags are set, it w
       #
       #   @param audio_codec [String] The audio codec used in the video (only for video/audio).
       #
@@ -238,7 +239,7 @@ module Imagekitio
       #
       #   @param name [String] Name of the asset.
       #
-      #   @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 selected_fields_schema [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}] This field is included in the response only if the Path policy feature is availa
       #
       #   @param size [Float] Size of the file in bytes.
       #
@@ -252,255 +253,12 @@ module Imagekitio
       #
       #   @param url [String] URL of the file.
       #
-      #   @param version_info [Imagekitio::Models::File::VersionInfo] An object with details of the file version.
+      #   @param version_info [Imagekitio::Models::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
-        # @!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
-        #   {Imagekitio::Models::File::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
-
-      class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel
-        # @!attribute type
-        #   Type of the custom metadata field.
-        #
-        #   @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
-        #   `type` of custom metadata field.
-        #
-        #   @return [String, Float, Boolean, Array<String, Float, Boolean>, nil]
-        optional :default_value,
-                 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, Imagekitio::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: -> {
-                   Imagekitio::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: -> {
-                   Imagekitio::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, Imagekitio::Internal::Type::Boolean, api_name: :readOnly
-
-        # @!attribute select_options
-        #   An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
-        #
-        #   @return [Array<String, Float, Boolean>, nil]
-        optional :select_options,
-                 -> {
-                   Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::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,
-                 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
-        #   {Imagekitio::Models::File::SelectedFieldsSchema} for more details.
-        #
-        #   @param type [Symbol, Imagekitio::Models::File::SelectedFieldsSchema::Type] Type of the custom metadata field.
-        #
-        #   @param default_value [String, Float, Boolean, Array<String, Float, Boolean>] 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<String, Float, Boolean>] 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 Imagekitio::Models::File::SelectedFieldsSchema#type
-        module Type
-          extend Imagekitio::Internal::Type::Enum
-
-          TEXT = :Text
-          TEXTAREA = :Textarea
-          NUMBER = :Number
-          DATE = :Date
-          BOOLEAN = :Boolean
-          SINGLE_SELECT = :SingleSelect
-          MULTI_SELECT = :MultiSelect
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # The default value for this custom metadata field. The value should match the
-        # `type` of custom metadata field.
-        #
-        # @see Imagekitio::Models::File::SelectedFieldsSchema#default_value
-        module DefaultValue
-          extend Imagekitio::Internal::Type::Union
-
-          variant String
-
-          variant Float
-
-          variant Imagekitio::Internal::Type::Boolean
-
-          # Default value should be of type array when custom metadata field type is set to `MultiSelect`.
-          variant -> { Imagekitio::Models::File::SelectedFieldsSchema::DefaultValue::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<String, Float, Boolean>)]
-
-          # @type [Imagekitio::Internal::Type::Converter]
-          MixedArray =
-            Imagekitio::Internal::Type::ArrayOf[union: -> {
-              Imagekitio::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 Imagekitio::Models::File::SelectedFieldsSchema#max_value
-        module MaxValue
-          extend Imagekitio::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 Imagekitio::Models::File::SelectedFieldsSchema#min_value
-        module MinValue
-          extend Imagekitio::Internal::Type::Union
-
-          variant String
-
-          variant Float
-
-          # @!method self.variants
-          #   @return [Array(String, Float)]
-        end
-
-        module SelectOption
-          extend Imagekitio::Internal::Type::Union
-
-          variant String
-
-          variant Float
-
-          variant Imagekitio::Internal::Type::Boolean
-
-          # @!method self.variants
-          #   @return [Array(String, Float, Boolean)]
-        end
-      end
-
       # Type of the asset.
       #
       # @see Imagekitio::Models::File#type
@@ -513,28 +271,6 @@ module Imagekitio
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      # @see Imagekitio::Models::File#version_info
-      class VersionInfo < Imagekitio::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

data/lib/imagekitio/models/file_create_event.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class FileCreateEvent < Imagekitio::Models::BaseWebhookEvent
+      # @!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 file or file version.
+      #
+      #   @return [Imagekitio::Models::File]
+      required :data, -> { Imagekitio::File }
+
+      # @!attribute type
+      #   Type of the webhook event.
+      #
+      #   @return [Symbol, :"file.created"]
+      required :type, const: :"file.created"
+
+      # @!method initialize(created_at:, data:, type: :"file.created")
+      #   Triggered when a file is created.
+      #
+      #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @param data [Imagekitio::Models::File] Object containing details of a file or file version.
+      #
+      #   @param type [Symbol, :"file.created"] Type of the webhook event.
+    end
+  end
+end

data/lib/imagekitio/models/file_delete_event.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class FileDeleteEvent < Imagekitio::Models::BaseWebhookEvent
+      # @!attribute created_at
+      #   Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute data
+      #
+      #   @return [Imagekitio::Models::FileDeleteEvent::Data]
+      required :data, -> { Imagekitio::FileDeleteEvent::Data }
+
+      # @!attribute type
+      #   Type of the webhook event.
+      #
+      #   @return [Symbol, :"file.deleted"]
+      required :type, const: :"file.deleted"
+
+      # @!method initialize(created_at:, data:, type: :"file.deleted")
+      #   Triggered when a file is deleted.
+      #
+      #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @param data [Imagekitio::Models::FileDeleteEvent::Data]
+      #
+      #   @param type [Symbol, :"file.deleted"] Type of the webhook event.
+
+      class Data < Imagekitio::Internal::Type::BaseModel
+        # @!attribute file_id
+        #   The unique `fileId` of the deleted file.
+        #
+        #   @return [String]
+        required :file_id, String, api_name: :fileId
+
+        # @!method initialize(file_id:)
+        #   @param file_id [String] The unique `fileId` of the deleted file.
+      end
+    end
+  end
+end

data/lib/imagekitio/models/file_update_event.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    class FileUpdateEvent < Imagekitio::Models::BaseWebhookEvent
+      # @!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 file or file version.
+      #
+      #   @return [Imagekitio::Models::File]
+      required :data, -> { Imagekitio::File }
+
+      # @!attribute type
+      #   Type of the webhook event.
+      #
+      #   @return [Symbol, :"file.updated"]
+      required :type, const: :"file.updated"
+
+      # @!method initialize(created_at:, data:, type: :"file.updated")
+      #   Triggered when a file is updated.
+      #
+      #   @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
+      #
+      #   @param data [Imagekitio::Models::File] Object containing details of a file or file version.
+      #
+      #   @param type [Symbol, :"file.updated"] Type of the webhook event.
+    end
+  end
+end