imagekitio 4.1.2 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ec9b8beb9b34a98e8c8cd782d36916135ac2f035955b0689f841bab5e151ae21
4
- data.tar.gz: 3cb4727f354d0455bdecc427a5597add3d2d4988a3e5f4eac88175fa29f3f7a1
3
+ metadata.gz: 1b92857709e6bb0bab7799b7475cc8bfba73a93b0f51b04d7e9bfcf63d4818ec
4
+ data.tar.gz: 4383584d3b958367e7ac4378bd36bba819aac8eb67a74c1ec21f123d1f9a2e39
5
5
  SHA512:
6
- metadata.gz: 8d2074ff86ab47a2842c7592c7d2a0819aa03d0c2cfa56e578280bf9d2b4c10943561ddaf29bb79eefa335a842156c73a6924bae721a1a48f83e798d5e530419
7
- data.tar.gz: c5f9b3552528f1c5778f9a83b7d27962f10b3d4a3ee24a5f14ce3e61087953948ce29eccb0905ec87955237ea0a4a776d9dc11a0d8e351a0d3fee042f302109e
6
+ metadata.gz: 3c0c0bfabf94611155871a5f4a33086c7943ee492e6ac4d9a93afe805ac9ea8463edd6e6d0098dc5662295775a428e30ffedd50b3b217838eea2de94412c7d1b
7
+ data.tar.gz: f6d394f0889d212baa8f160cc5676ef25fdf212d4c2fac50b321bb597c110585fdec997952fe40f4c5a6b638acf504ee563bddbadd90520e356780b77170ae24
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## 4.2.0 (2026-02-02)
4
+
5
+ Full Changelog: [v4.1.2...v4.2.0](https://github.com/imagekit-developer/imagekit-ruby/compare/v4.1.2...v4.2.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** add customMetadata property to folder schema ([8038b9e](https://github.com/imagekit-developer/imagekit-ruby/commit/8038b9ecc161c7d25c65a35c2d54149ace184479))
10
+
11
+
12
+ ### Bug Fixes
13
+
14
+ * **api:** add missing embeddedMetadata and video properties to FileDetails ([898add4](https://github.com/imagekit-developer/imagekit-ruby/commit/898add425e5839e85fc8cca8bd8035923ec39463))
15
+
3
16
  ## 4.1.2 (2026-01-29)
4
17
 
5
18
  Full Changelog: [v4.1.1...v4.1.2](https://github.com/imagekit-developer/imagekit-ruby/compare/v4.1.1...v4.1.2)
data/README.md CHANGED
@@ -45,7 +45,7 @@ To use this gem, install via Bundler by adding the following to your application
45
45
  <!-- x-release-please-start-version -->
46
46
 
47
47
  ```ruby
48
- gem "imagekitio", "~> 4.1.2"
48
+ gem "imagekitio", "~> 4.2.0"
49
49
  ```
50
50
 
51
51
  <!-- x-release-please-end -->
@@ -13,6 +13,18 @@ module Imagekitio
13
13
  api_name: :AITags,
14
14
  nil?: true
15
15
 
16
+ # @!attribute audio_codec
17
+ # The audio codec used in the video (only for video/audio).
18
+ #
19
+ # @return [String, nil]
20
+ optional :audio_codec, String, api_name: :audioCodec
21
+
22
+ # @!attribute bit_rate
23
+ # The bit rate of the video in kbps (only for video).
24
+ #
25
+ # @return [Integer, nil]
26
+ optional :bit_rate, Integer, api_name: :bitRate
27
+
16
28
  # @!attribute created_at
17
29
  # Date and time when the file was uploaded. The date and time is in ISO8601
18
30
  # format.
@@ -41,6 +53,21 @@ module Imagekitio
41
53
  # @return [String, nil]
42
54
  optional :description, String
43
55
 
56
+ # @!attribute duration
57
+ # The duration of the video in seconds (only for video).
58
+ #
59
+ # @return [Integer, nil]
60
+ optional :duration, Integer
61
+
62
+ # @!attribute embedded_metadata
63
+ # Consolidated embedded metadata associated with the file. It includes exif, iptc,
64
+ # and xmp data.
65
+ #
66
+ # @return [Hash{Symbol=>Object}, nil]
67
+ optional :embedded_metadata,
68
+ Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown],
69
+ api_name: :embeddedMetadata
70
+
44
71
  # @!attribute file_id
45
72
  # Unique identifier of the asset.
46
73
  #
@@ -157,13 +184,19 @@ module Imagekitio
157
184
  # @return [Imagekitio::Models::File::VersionInfo, nil]
158
185
  optional :version_info, -> { Imagekitio::File::VersionInfo }, api_name: :versionInfo
159
186
 
187
+ # @!attribute video_codec
188
+ # The video codec used in the video (only for video).
189
+ #
190
+ # @return [String, nil]
191
+ optional :video_codec, String, api_name: :videoCodec
192
+
160
193
  # @!attribute width
161
194
  # Width of the file.
162
195
  #
163
196
  # @return [Float, nil]
164
197
  optional :width, Float
165
198
 
166
- # @!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)
199
+ # @!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)
167
200
  # Some parameter documentations has been truncated, see {Imagekitio::Models::File}
168
201
  # for more details.
169
202
  #
@@ -171,6 +204,10 @@ module Imagekitio
171
204
  #
172
205
  # @param ai_tags [Array<Imagekitio::Models::File::AITag>, nil] An array of tags assigned to the file by auto tagging.
173
206
  #
207
+ # @param audio_codec [String] The audio codec used in the video (only for video/audio).
208
+ #
209
+ # @param bit_rate [Integer] The bit rate of the video in kbps (only for video).
210
+ #
174
211
  # @param created_at [Time] Date and time when the file was uploaded. The date and time is in ISO8601 format
175
212
  #
176
213
  # @param custom_coordinates [String, nil] An string with custom coordinates of the file.
@@ -179,6 +216,10 @@ module Imagekitio
179
216
  #
180
217
  # @param description [String] Optional text to describe the contents of the file. Can be set by the user or th
181
218
  #
219
+ # @param duration [Integer] The duration of the video in seconds (only for video).
220
+ #
221
+ # @param embedded_metadata [Hash{Symbol=>Object}] Consolidated embedded metadata associated with the file. It includes exif, iptc,
222
+ #
182
223
  # @param file_id [String] Unique identifier of the asset.
183
224
  #
184
225
  # @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 @@ module Imagekitio
213
254
  #
214
255
  # @param version_info [Imagekitio::Models::File::VersionInfo] An object with details of the file version.
215
256
  #
257
+ # @param video_codec [String] The video codec used in the video (only for video).
258
+ #
216
259
  # @param width [Float] Width of the file.
217
260
 
218
261
  class AITag < Imagekitio::Internal::Type::BaseModel
@@ -10,6 +10,15 @@ module Imagekitio
10
10
  # @return [Time, nil]
11
11
  optional :created_at, Time, api_name: :createdAt
12
12
 
13
+ # @!attribute custom_metadata
14
+ # An object with custom metadata for the folder. Returns empty object if no custom
15
+ # metadata is set.
16
+ #
17
+ # @return [Hash{Symbol=>Object}, nil]
18
+ optional :custom_metadata,
19
+ Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown],
20
+ api_name: :customMetadata
21
+
13
22
  # @!attribute folder_id
14
23
  # Unique identifier of the asset.
15
24
  #
@@ -44,12 +53,14 @@ module Imagekitio
44
53
  # @return [Time, nil]
45
54
  optional :updated_at, Time, api_name: :updatedAt
46
55
 
47
- # @!method initialize(created_at: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil)
56
+ # @!method initialize(created_at: nil, custom_metadata: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil)
48
57
  # Some parameter documentations has been truncated, see
49
58
  # {Imagekitio::Models::Folder} for more details.
50
59
  #
51
60
  # @param created_at [Time] Date and time when the folder was created. The date and time is in ISO8601 forma
52
61
  #
62
+ # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the folder. Returns empty object if no custom
63
+ #
53
64
  # @param folder_id [String] Unique identifier of the asset.
54
65
  #
55
66
  # @param folder_path [String] Path of the folder. This is the path you would use in the URL to access the fold
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Imagekitio
4
- VERSION = "4.1.2"
4
+ VERSION = "4.2.0"
5
5
  end
@@ -10,6 +10,20 @@ module Imagekitio
10
10
  sig { returns(T.nilable(T::Array[Imagekitio::File::AITag])) }
11
11
  attr_accessor :ai_tags
12
12
 
13
+ # The audio codec used in the video (only for video/audio).
14
+ sig { returns(T.nilable(String)) }
15
+ attr_reader :audio_codec
16
+
17
+ sig { params(audio_codec: String).void }
18
+ attr_writer :audio_codec
19
+
20
+ # The bit rate of the video in kbps (only for video).
21
+ sig { returns(T.nilable(Integer)) }
22
+ attr_reader :bit_rate
23
+
24
+ sig { params(bit_rate: Integer).void }
25
+ attr_writer :bit_rate
26
+
13
27
  # Date and time when the file was uploaded. The date and time is in ISO8601
14
28
  # format.
15
29
  sig { returns(T.nilable(Time)) }
@@ -37,6 +51,21 @@ module Imagekitio
37
51
  sig { params(description: String).void }
38
52
  attr_writer :description
39
53
 
54
+ # The duration of the video in seconds (only for video).
55
+ sig { returns(T.nilable(Integer)) }
56
+ attr_reader :duration
57
+
58
+ sig { params(duration: Integer).void }
59
+ attr_writer :duration
60
+
61
+ # Consolidated embedded metadata associated with the file. It includes exif, iptc,
62
+ # and xmp data.
63
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
64
+ attr_reader :embedded_metadata
65
+
66
+ sig { params(embedded_metadata: T::Hash[Symbol, T.anything]).void }
67
+ attr_writer :embedded_metadata
68
+
40
69
  # Unique identifier of the asset.
41
70
  sig { returns(T.nilable(String)) }
42
71
  attr_reader :file_id
@@ -174,6 +203,13 @@ module Imagekitio
174
203
  sig { params(version_info: Imagekitio::File::VersionInfo::OrHash).void }
175
204
  attr_writer :version_info
176
205
 
206
+ # The video codec used in the video (only for video).
207
+ sig { returns(T.nilable(String)) }
208
+ attr_reader :video_codec
209
+
210
+ sig { params(video_codec: String).void }
211
+ attr_writer :video_codec
212
+
177
213
  # Width of the file.
178
214
  sig { returns(T.nilable(Float)) }
179
215
  attr_reader :width
@@ -185,10 +221,14 @@ module Imagekitio
185
221
  sig do
186
222
  params(
187
223
  ai_tags: T.nilable(T::Array[Imagekitio::File::AITag::OrHash]),
224
+ audio_codec: String,
225
+ bit_rate: Integer,
188
226
  created_at: Time,
189
227
  custom_coordinates: T.nilable(String),
190
228
  custom_metadata: T::Hash[Symbol, T.anything],
191
229
  description: String,
230
+ duration: Integer,
231
+ embedded_metadata: T::Hash[Symbol, T.anything],
192
232
  file_id: String,
193
233
  file_path: String,
194
234
  file_type: String,
@@ -207,12 +247,17 @@ module Imagekitio
207
247
  updated_at: Time,
208
248
  url: String,
209
249
  version_info: Imagekitio::File::VersionInfo::OrHash,
250
+ video_codec: String,
210
251
  width: Float
211
252
  ).returns(T.attached_class)
212
253
  end
213
254
  def self.new(
214
255
  # An array of tags assigned to the file by auto tagging.
215
256
  ai_tags: nil,
257
+ # The audio codec used in the video (only for video/audio).
258
+ audio_codec: nil,
259
+ # The bit rate of the video in kbps (only for video).
260
+ bit_rate: nil,
216
261
  # Date and time when the file was uploaded. The date and time is in ISO8601
217
262
  # format.
218
263
  created_at: nil,
@@ -223,6 +268,11 @@ module Imagekitio
223
268
  # Optional text to describe the contents of the file. Can be set by the user or
224
269
  # the ai-auto-description extension.
225
270
  description: nil,
271
+ # The duration of the video in seconds (only for video).
272
+ duration: nil,
273
+ # Consolidated embedded metadata associated with the file. It includes exif, iptc,
274
+ # and xmp data.
275
+ embedded_metadata: nil,
226
276
  # Unique identifier of the asset.
227
277
  file_id: nil,
228
278
  # Path of the file. This is the path you would use in the URL to access the file.
@@ -269,6 +319,8 @@ module Imagekitio
269
319
  url: nil,
270
320
  # An object with details of the file version.
271
321
  version_info: nil,
322
+ # The video codec used in the video (only for video).
323
+ video_codec: nil,
272
324
  # Width of the file.
273
325
  width: nil
274
326
  )
@@ -278,10 +330,14 @@ module Imagekitio
278
330
  override.returns(
279
331
  {
280
332
  ai_tags: T.nilable(T::Array[Imagekitio::File::AITag]),
333
+ audio_codec: String,
334
+ bit_rate: Integer,
281
335
  created_at: Time,
282
336
  custom_coordinates: T.nilable(String),
283
337
  custom_metadata: T::Hash[Symbol, T.anything],
284
338
  description: String,
339
+ duration: Integer,
340
+ embedded_metadata: T::Hash[Symbol, T.anything],
285
341
  file_id: String,
286
342
  file_path: String,
287
343
  file_type: String,
@@ -300,6 +356,7 @@ module Imagekitio
300
356
  updated_at: Time,
301
357
  url: String,
302
358
  version_info: Imagekitio::File::VersionInfo,
359
+ video_codec: String,
303
360
  width: Float
304
361
  }
305
362
  )
@@ -16,6 +16,14 @@ module Imagekitio
16
16
  sig { params(created_at: Time).void }
17
17
  attr_writer :created_at
18
18
 
19
+ # An object with custom metadata for the folder. Returns empty object if no custom
20
+ # metadata is set.
21
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
22
+ attr_reader :custom_metadata
23
+
24
+ sig { params(custom_metadata: T::Hash[Symbol, T.anything]).void }
25
+ attr_writer :custom_metadata
26
+
19
27
  # Unique identifier of the asset.
20
28
  sig { returns(T.nilable(String)) }
21
29
  attr_reader :folder_id
@@ -58,6 +66,7 @@ module Imagekitio
58
66
  sig do
59
67
  params(
60
68
  created_at: Time,
69
+ custom_metadata: T::Hash[Symbol, T.anything],
61
70
  folder_id: String,
62
71
  folder_path: String,
63
72
  name: String,
@@ -69,6 +78,9 @@ module Imagekitio
69
78
  # Date and time when the folder was created. The date and time is in ISO8601
70
79
  # format.
71
80
  created_at: nil,
81
+ # An object with custom metadata for the folder. Returns empty object if no custom
82
+ # metadata is set.
83
+ custom_metadata: nil,
72
84
  # Unique identifier of the asset.
73
85
  folder_id: nil,
74
86
  # Path of the folder. This is the path you would use in the URL to access the
@@ -90,6 +102,7 @@ module Imagekitio
90
102
  override.returns(
91
103
  {
92
104
  created_at: Time,
105
+ custom_metadata: T::Hash[Symbol, T.anything],
93
106
  folder_id: String,
94
107
  folder_path: String,
95
108
  name: String,
@@ -3,10 +3,14 @@ module Imagekitio
3
3
  type file =
4
4
  {
5
5
  ai_tags: ::Array[Imagekitio::File::AITag]?,
6
+ audio_codec: String,
7
+ bit_rate: Integer,
6
8
  created_at: Time,
7
9
  custom_coordinates: String?,
8
10
  custom_metadata: ::Hash[Symbol, top],
9
11
  description: String,
12
+ duration: Integer,
13
+ embedded_metadata: ::Hash[Symbol, top],
10
14
  file_id: String,
11
15
  file_path: String,
12
16
  file_type: String,
@@ -24,12 +28,21 @@ module Imagekitio
24
28
  updated_at: Time,
25
29
  url: String,
26
30
  version_info: Imagekitio::File::VersionInfo,
31
+ video_codec: String,
27
32
  width: Float
28
33
  }
29
34
 
30
35
  class File < Imagekitio::Internal::Type::BaseModel
31
36
  attr_accessor ai_tags: ::Array[Imagekitio::File::AITag]?
32
37
 
38
+ attr_reader audio_codec: String?
39
+
40
+ def audio_codec=: (String) -> String
41
+
42
+ attr_reader bit_rate: Integer?
43
+
44
+ def bit_rate=: (Integer) -> Integer
45
+
33
46
  attr_reader created_at: Time?
34
47
 
35
48
  def created_at=: (Time) -> Time
@@ -44,6 +57,14 @@ module Imagekitio
44
57
 
45
58
  def description=: (String) -> String
46
59
 
60
+ attr_reader duration: Integer?
61
+
62
+ def duration=: (Integer) -> Integer
63
+
64
+ attr_reader embedded_metadata: ::Hash[Symbol, top]?
65
+
66
+ def embedded_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
67
+
47
68
  attr_reader file_id: String?
48
69
 
49
70
  def file_id=: (String) -> String
@@ -116,16 +137,24 @@ module Imagekitio
116
137
  Imagekitio::File::VersionInfo
117
138
  ) -> Imagekitio::File::VersionInfo
118
139
 
140
+ attr_reader video_codec: String?
141
+
142
+ def video_codec=: (String) -> String
143
+
119
144
  attr_reader width: Float?
120
145
 
121
146
  def width=: (Float) -> Float
122
147
 
123
148
  def initialize: (
124
149
  ?ai_tags: ::Array[Imagekitio::File::AITag]?,
150
+ ?audio_codec: String,
151
+ ?bit_rate: Integer,
125
152
  ?created_at: Time,
126
153
  ?custom_coordinates: String?,
127
154
  ?custom_metadata: ::Hash[Symbol, top],
128
155
  ?description: String,
156
+ ?duration: Integer,
157
+ ?embedded_metadata: ::Hash[Symbol, top],
129
158
  ?file_id: String,
130
159
  ?file_path: String,
131
160
  ?file_type: String,
@@ -143,15 +172,20 @@ module Imagekitio
143
172
  ?updated_at: Time,
144
173
  ?url: String,
145
174
  ?version_info: Imagekitio::File::VersionInfo,
175
+ ?video_codec: String,
146
176
  ?width: Float
147
177
  ) -> void
148
178
 
149
179
  def to_hash: -> {
150
180
  ai_tags: ::Array[Imagekitio::File::AITag]?,
181
+ audio_codec: String,
182
+ bit_rate: Integer,
151
183
  created_at: Time,
152
184
  custom_coordinates: String?,
153
185
  custom_metadata: ::Hash[Symbol, top],
154
186
  description: String,
187
+ duration: Integer,
188
+ embedded_metadata: ::Hash[Symbol, top],
155
189
  file_id: String,
156
190
  file_path: String,
157
191
  file_type: String,
@@ -169,6 +203,7 @@ module Imagekitio
169
203
  updated_at: Time,
170
204
  url: String,
171
205
  version_info: Imagekitio::File::VersionInfo,
206
+ video_codec: String,
172
207
  width: Float
173
208
  }
174
209
 
@@ -3,6 +3,7 @@ module Imagekitio
3
3
  type folder =
4
4
  {
5
5
  created_at: Time,
6
+ custom_metadata: ::Hash[Symbol, top],
6
7
  folder_id: String,
7
8
  folder_path: String,
8
9
  name: String,
@@ -15,6 +16,10 @@ module Imagekitio
15
16
 
16
17
  def created_at=: (Time) -> Time
17
18
 
19
+ attr_reader custom_metadata: ::Hash[Symbol, top]?
20
+
21
+ def custom_metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
22
+
18
23
  attr_reader folder_id: String?
19
24
 
20
25
  def folder_id=: (String) -> String
@@ -39,6 +44,7 @@ module Imagekitio
39
44
 
40
45
  def initialize: (
41
46
  ?created_at: Time,
47
+ ?custom_metadata: ::Hash[Symbol, top],
42
48
  ?folder_id: String,
43
49
  ?folder_path: String,
44
50
  ?name: String,
@@ -48,6 +54,7 @@ module Imagekitio
48
54
 
49
55
  def to_hash: -> {
50
56
  created_at: Time,
57
+ custom_metadata: ::Hash[Symbol, top],
51
58
  folder_id: String,
52
59
  folder_path: String,
53
60
  name: String,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: imagekitio
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.2
4
+ version: 4.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - ImageKit
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-01-29 00:00:00.000000000 Z
11
+ date: 2026-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi