imagekitio 3.0.0 → 4.0.0

data/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<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/imagekitio/models/custom_metadata_field.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @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.
+      #
+      #   @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 [Imagekitio::Models::CustomMetadataField::Schema]
+      required :schema, -> { Imagekitio::CustomMetadataField::Schema }
+
+      # @!method initialize(id:, label:, name:, schema:)
+      #   Some parameter documentations has been truncated, see
+      #   {Imagekitio::Models::CustomMetadataField} 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 [Imagekitio::Models::CustomMetadataField::Schema] An object that describes the rules for the custom metadata field value.
+
+      # @see Imagekitio::Models::CustomMetadataField#schema
+      class Schema < Imagekitio::Internal::Type::BaseModel
+        # @!attribute type
+        #   Type of the custom metadata field.
+        #
+        #   @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
+        #   depends on the field type.
+        #
+        #   @return [String, Float, Boolean, Array<String, Float, Boolean>, nil]
+        optional :default_value,
+                 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, 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::CustomMetadataField::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: -> {
+                   Imagekitio::CustomMetadataField::Schema::MinValue
+                 },
+                 api_name: :minValue
+
+        # @!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::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
+        #   {Imagekitio::Models::CustomMetadataField::Schema} for more details.
+        #
+        #   An object that describes the rules for the custom metadata field value.
+        #
+        #   @param type [Symbol, Imagekitio::Models::CustomMetadataField::Schema::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. Data 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<String, Float, Boolean>] An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
+
+        # Type of the custom metadata field.
+        #
+        # @see Imagekitio::Models::CustomMetadataField::Schema#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. Data type of default value
+        # depends on the field type.
+        #
+        # @see Imagekitio::Models::CustomMetadataField::Schema#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::CustomMetadataField::Schema::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::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 Imagekitio::Models::CustomMetadataField::Schema#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::CustomMetadataField::Schema#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
+    end
+  end
+end

data/lib/imagekitio/models/custom_metadata_field_create_params.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @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
+      #   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 [Imagekitio::Models::CustomMetadataFieldCreateParams::Schema]
+      required :schema, -> { Imagekitio::CustomMetadataFieldCreateParams::Schema }
+
+      # @!method initialize(label:, name:, schema:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {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 [Imagekitio::Models::CustomMetadataFieldCreateParams::Schema]
+      #
+      #   @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+
+      class Schema < Imagekitio::Internal::Type::BaseModel
+        # @!attribute type
+        #   Type of the custom metadata field.
+        #
+        #   @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
+        #   if `isValueRequired` property is set to `true`. The value should match the
+        #   `type` of custom metadata field.
+        #
+        #   @return [String, Float, Boolean, Array<String, Float, Boolean>, nil]
+        optional :default_value,
+                 union: -> { Imagekitio::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, 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
+        #   `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: -> { Imagekitio::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: -> { Imagekitio::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<String, Float, Boolean>, nil]
+        optional :select_options,
+                 -> {
+                   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
+        #   {Imagekitio::Models::CustomMetadataFieldCreateParams::Schema} for more details.
+        #
+        #   @param type [Symbol, Imagekitio::Models::CustomMetadataFieldCreateParams::Schema::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. 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<String, Float, Boolean>] An array of allowed values. This property is only required if `type` property is
+
+        # Type of the custom metadata field.
+        #
+        # @see Imagekitio::Models::CustomMetadataFieldCreateParams::Schema#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. This property is only required
+        # if `isValueRequired` property is set to `true`. The value should match the
+        # `type` of custom metadata field.
+        #
+        # @see Imagekitio::Models::CustomMetadataFieldCreateParams::Schema#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::CustomMetadataFieldCreateParams::Schema::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::CustomMetadataFieldCreateParams::Schema::DefaultValue::Mixed
+            }]
+        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 Imagekitio::Models::CustomMetadataFieldCreateParams::Schema#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 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 Imagekitio::Models::CustomMetadataFieldCreateParams::Schema#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
+    end
+  end
+end

data/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

data/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

data/lib/imagekitio/models/custom_metadata_field_list_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  module Models
+    # @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
+      #   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, Imagekitio::Internal::Type::Boolean
+
+      # @!method initialize(folder_path: nil, include_deleted: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {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 [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/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