Skip to content

Commit 6a074df

Browse files
feat(api): add missing types in ruby
1 parent 01a4f00 commit 6a074df

36 files changed

Lines changed: 1274 additions & 336 deletions

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 47
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-70c42eda2bee929830b2537f758400a58dded1f1ef5686a286e2469c35a041a0.yml
33
openapi_spec_hash: cdaeed824e91657b45092765cf55eb42
4-
config_hash: e3c2679d25f6235381dfb11962fbf3d9
4+
config_hash: 83967503e501e4199b4042d0d0f2b615

lib/imagekitio.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@
7676
require_relative "imagekitio/models/accounts/url_endpoint_update_params"
7777
require_relative "imagekitio/models/accounts/usage_get_params"
7878
require_relative "imagekitio/models/accounts/usage_get_response"
79+
require_relative "imagekitio/models/ai_tag"
7980
require_relative "imagekitio/models/asset_list_params"
8081
require_relative "imagekitio/models/asset_list_response"
8182
require_relative "imagekitio/models/beta/v2/file_upload_params"
@@ -84,13 +85,15 @@
8485
require_relative "imagekitio/models/cache/invalidation_create_response"
8586
require_relative "imagekitio/models/cache/invalidation_get_params"
8687
require_relative "imagekitio/models/cache/invalidation_get_response"
88+
require_relative "imagekitio/models/custom_metadata"
8789
require_relative "imagekitio/models/custom_metadata_field"
8890
require_relative "imagekitio/models/custom_metadata_field_create_params"
8991
require_relative "imagekitio/models/custom_metadata_field_delete_params"
9092
require_relative "imagekitio/models/custom_metadata_field_delete_response"
9193
require_relative "imagekitio/models/custom_metadata_field_list_params"
9294
require_relative "imagekitio/models/custom_metadata_field_list_response"
9395
require_relative "imagekitio/models/custom_metadata_field_update_params"
96+
require_relative "imagekitio/models/embedded_metadata"
9497
require_relative "imagekitio/models/extension_config"
9598
require_relative "imagekitio/models/extensions"
9699
require_relative "imagekitio/models/file_copy_params"
@@ -153,6 +156,7 @@
153156
require_relative "imagekitio/models/saved_extension_list_params"
154157
require_relative "imagekitio/models/saved_extension_list_response"
155158
require_relative "imagekitio/models/saved_extension_update_params"
159+
require_relative "imagekitio/models/selected_fields_schema"
156160
require_relative "imagekitio/models/solid_color_overlay"
157161
require_relative "imagekitio/models/solid_color_overlay_transformation"
158162
require_relative "imagekitio/models/streaming_resolution"
@@ -168,6 +172,7 @@
168172
require_relative "imagekitio/models/upload_post_transform_success_event"
169173
require_relative "imagekitio/models/upload_pre_transform_error_event"
170174
require_relative "imagekitio/models/upload_pre_transform_success_event"
175+
require_relative "imagekitio/models/version_info"
171176
require_relative "imagekitio/models/video_overlay"
172177
require_relative "imagekitio/models/video_transformation_accepted_event"
173178
require_relative "imagekitio/models/video_transformation_error_event"

lib/imagekitio/internal/type/base_model.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -438,11 +438,11 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false)
438438
# @return [Hash{Symbol=>Object}]
439439
#
440440
# @example
441-
# # `base_overlay` is a `Imagekitio::BaseOverlay`
442-
# base_overlay => {
443-
# layer_mode: layer_mode,
444-
# position: position,
445-
# timing: timing
441+
# # `ai_tag` is a `Imagekitio::AITag`
442+
# ai_tag => {
443+
# confidence: confidence,
444+
# name: name,
445+
# source: source
446446
# }
447447
def deconstruct_keys(keys)
448448
(keys || self.class.known_fields.keys)

lib/imagekitio/models.rb

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ module Imagekitio
4141

4242
Accounts = Imagekitio::Models::Accounts
4343

44+
AITag = Imagekitio::Models::AITag
45+
4446
AssetListParams = Imagekitio::Models::AssetListParams
4547

4648
BaseOverlay = Imagekitio::Models::BaseOverlay
@@ -51,6 +53,9 @@ module Imagekitio
5153

5254
Cache = Imagekitio::Models::Cache
5355

56+
# @type [Imagekitio::Internal::Type::Converter]
57+
CustomMetadata = Imagekitio::Models::CustomMetadata
58+
5459
CustomMetadataField = Imagekitio::Models::CustomMetadataField
5560

5661
CustomMetadataFieldCreateParams = Imagekitio::Models::CustomMetadataFieldCreateParams
@@ -61,6 +66,9 @@ module Imagekitio
6166

6267
CustomMetadataFieldUpdateParams = Imagekitio::Models::CustomMetadataFieldUpdateParams
6368

69+
# @type [Imagekitio::Internal::Type::Converter]
70+
EmbeddedMetadata = Imagekitio::Models::EmbeddedMetadata
71+
6472
ExtensionConfig = Imagekitio::Models::ExtensionConfig
6573

6674
ExtensionItem = Imagekitio::Models::ExtensionItem
@@ -136,6 +144,11 @@ module Imagekitio
136144

137145
SavedExtensionUpdateParams = Imagekitio::Models::SavedExtensionUpdateParams
138146

147+
# @type [Imagekitio::Internal::Type::Converter]
148+
SelectedFieldsSchema = Imagekitio::Models::SelectedFieldsSchema
149+
150+
SelectedFieldsSchemaItem = Imagekitio::Models::SelectedFieldsSchemaItem
151+
139152
SolidColorOverlay = Imagekitio::Models::SolidColorOverlay
140153

141154
SolidColorOverlayTransformation = Imagekitio::Models::SolidColorOverlayTransformation
@@ -170,6 +183,8 @@ module Imagekitio
170183

171184
UploadPreTransformSuccessEvent = Imagekitio::Models::UploadPreTransformSuccessEvent
172185

186+
VersionInfo = Imagekitio::Models::VersionInfo
187+
173188
VideoOverlay = Imagekitio::Models::VideoOverlay
174189

175190
VideoTransformationAcceptedEvent = Imagekitio::Models::VideoTransformationAcceptedEvent

lib/imagekitio/models/ai_tag.rb

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# frozen_string_literal: true
2+
3+
module Imagekitio
4+
module Models
5+
class AITag < Imagekitio::Internal::Type::BaseModel
6+
# @!attribute confidence
7+
# Confidence score of the tag.
8+
#
9+
# @return [Float, nil]
10+
optional :confidence, Float
11+
12+
# @!attribute name
13+
# Name of the tag.
14+
#
15+
# @return [String, nil]
16+
optional :name, String
17+
18+
# @!attribute source
19+
# Source of the tag. Possible values are `google-auto-tagging` and
20+
# `aws-auto-tagging`.
21+
#
22+
# @return [String, nil]
23+
optional :source, String
24+
25+
# @!method initialize(confidence: nil, name: nil, source: nil)
26+
# Some parameter documentations has been truncated, see
27+
# {Imagekitio::Models::AITag} for more details.
28+
#
29+
# AI-generated tag associated with an image. These tags can be added using the
30+
# `google-auto-tagging` or `aws-auto-tagging` extensions.
31+
#
32+
# @param confidence [Float] Confidence score of the tag.
33+
#
34+
# @param name [String] Name of the tag.
35+
#
36+
# @param source [String] Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-taggi
37+
end
38+
end
39+
end

lib/imagekitio/models/beta/v2/file_upload_response.rb

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
99
# @!attribute ai_tags
1010
# An array of tags assigned to the uploaded file by auto tagging.
1111
#
12-
# @return [Array<Imagekitio::Models::Beta::V2::FileUploadResponse::AITag>, nil]
12+
# @return [Array<Imagekitio::Models::AITag>, nil]
1313
optional :ai_tags,
14-
-> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Models::Beta::V2::FileUploadResponse::AITag] },
14+
-> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::AITag] },
1515
api_name: :AITags,
1616
nil?: true
1717

@@ -151,9 +151,9 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
151151
# Keys are the names of the custom metadata fields; the value object has details
152152
# about the custom metadata schema.
153153
#
154-
# @return [Hash{Symbol=>Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema}, nil]
154+
# @return [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}, nil]
155155
optional :selected_fields_schema,
156-
-> { Imagekitio::Internal::Type::HashOf[Imagekitio::Models::Beta::V2::FileUploadResponse::SelectedFieldsSchema] },
156+
-> { Imagekitio::Internal::Type::HashOf[Imagekitio::SelectedFieldsSchemaItem] },
157157
api_name: :selectedFieldsSchema
158158

159159
# @!attribute size
@@ -185,10 +185,8 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
185185
# @!attribute version_info
186186
# An object containing the file or file version's `id` (versionId) and `name`.
187187
#
188-
# @return [Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo, nil]
189-
optional :version_info,
190-
-> { Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo },
191-
api_name: :versionInfo
188+
# @return [Imagekitio::Models::VersionInfo, nil]
189+
optional :version_info, -> { Imagekitio::VersionInfo }, api_name: :versionInfo
192190

193191
# @!attribute video_codec
194192
# The video codec used in the video (only for video).
@@ -208,7 +206,7 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
208206
#
209207
# Object containing details of a successful upload.
210208
#
211-
# @param ai_tags [Array<Imagekitio::Models::Beta::V2::FileUploadResponse::AITag>, nil] An array of tags assigned to the uploaded file by auto tagging.
209+
# @param ai_tags [Array<Imagekitio::Models::AITag>, nil] An array of tags assigned to the uploaded file by auto tagging.
212210
#
213211
# @param audio_codec [String] The audio codec used in the video (only for video).
214212
#
@@ -242,7 +240,7 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
242240
#
243241
# @param name [String] Name of the asset.
244242
#
245-
# @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
243+
# @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}] This field is included in the response only if the Path policy feature is availa
246244
#
247245
# @param size [Float] Size of the image file in Bytes.
248246
#
@@ -252,7 +250,7 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
252250
#
253251
# @param url [String] A publicly accessible URL of the file.
254252
#
255-
# @param version_info [Imagekitio::Models::Beta::V2::FileUploadResponse::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`.
253+
# @param version_info [Imagekitio::Models::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`.
256254
#
257255
# @param video_codec [String] The video codec used in the video (only for video).
258256
#
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# frozen_string_literal: true
2+
3+
module Imagekitio
4+
module Models
5+
# @type [Imagekitio::Internal::Type::Converter]
6+
CustomMetadata = Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]
7+
end
8+
end
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# frozen_string_literal: true
2+
3+
module Imagekitio
4+
module Models
5+
# @type [Imagekitio::Internal::Type::Converter]
6+
EmbeddedMetadata = Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown]
7+
end
8+
end

lib/imagekitio/models/file.rb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ class File < Imagekitio::Internal::Type::BaseModel
88
# Array of AI-generated tags associated with the image. If no AITags are set, it
99
# will be null.
1010
#
11-
# @return [Array<Imagekitio::Models::File::AITag>, nil]
11+
# @return [Array<Imagekitio::Models::AITag>, nil]
1212
optional :ai_tags,
13-
-> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::File::AITag] },
13+
-> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::AITag] },
1414
api_name: :AITags,
1515
nil?: true
1616

@@ -135,9 +135,9 @@ class File < Imagekitio::Internal::Type::BaseModel
135135
# Keys are the names of the custom metadata fields; the value object has details
136136
# about the custom metadata schema.
137137
#
138-
# @return [Hash{Symbol=>Imagekitio::Models::File::SelectedFieldsSchema}, nil]
138+
# @return [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}, nil]
139139
optional :selected_fields_schema,
140-
-> { Imagekitio::Internal::Type::HashOf[Imagekitio::File::SelectedFieldsSchema] },
140+
-> { Imagekitio::Internal::Type::HashOf[Imagekitio::SelectedFieldsSchemaItem] },
141141
api_name: :selectedFieldsSchema
142142

143143
# @!attribute size
@@ -182,8 +182,8 @@ class File < Imagekitio::Internal::Type::BaseModel
182182
# @!attribute version_info
183183
# An object with details of the file version.
184184
#
185-
# @return [Imagekitio::Models::File::VersionInfo, nil]
186-
optional :version_info, -> { Imagekitio::File::VersionInfo }, api_name: :versionInfo
185+
# @return [Imagekitio::Models::VersionInfo, nil]
186+
optional :version_info, -> { Imagekitio::VersionInfo }, api_name: :versionInfo
187187

188188
# @!attribute video_codec
189189
# The video codec used in the video (only for video).
@@ -203,7 +203,7 @@ class File < Imagekitio::Internal::Type::BaseModel
203203
#
204204
# Object containing details of a file or file version.
205205
#
206-
# @param ai_tags [Array<Imagekitio::Models::File::AITag>, nil] Array of AI-generated tags associated with the image. If no AITags are set, it w
206+
# @param ai_tags [Array<Imagekitio::Models::AITag>, nil] Array of AI-generated tags associated with the image. If no AITags are set, it w
207207
#
208208
# @param audio_codec [String] The audio codec used in the video (only for video/audio).
209209
#
@@ -239,7 +239,7 @@ class File < Imagekitio::Internal::Type::BaseModel
239239
#
240240
# @param name [String] Name of the asset.
241241
#
242-
# @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
242+
# @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}] This field is included in the response only if the Path policy feature is availa
243243
#
244244
# @param size [Float] Size of the file in bytes.
245245
#
@@ -253,7 +253,7 @@ class File < Imagekitio::Internal::Type::BaseModel
253253
#
254254
# @param url [String] URL of the file.
255255
#
256-
# @param version_info [Imagekitio::Models::File::VersionInfo] An object with details of the file version.
256+
# @param version_info [Imagekitio::Models::VersionInfo] An object with details of the file version.
257257
#
258258
# @param video_codec [String] The video codec used in the video (only for video).
259259
#

lib/imagekitio/models/file_upload_response.rb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
77
# @!attribute ai_tags
88
# An array of tags assigned to the uploaded file by auto tagging.
99
#
10-
# @return [Array<Imagekitio::Models::FileUploadResponse::AITag>, nil]
10+
# @return [Array<Imagekitio::Models::AITag>, nil]
1111
optional :ai_tags,
12-
-> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Models::FileUploadResponse::AITag] },
12+
-> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::AITag] },
1313
api_name: :AITags,
1414
nil?: true
1515

@@ -149,9 +149,9 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
149149
# Keys are the names of the custom metadata fields; the value object has details
150150
# about the custom metadata schema.
151151
#
152-
# @return [Hash{Symbol=>Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema}, nil]
152+
# @return [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}, nil]
153153
optional :selected_fields_schema,
154-
-> { Imagekitio::Internal::Type::HashOf[Imagekitio::Models::FileUploadResponse::SelectedFieldsSchema] },
154+
-> { Imagekitio::Internal::Type::HashOf[Imagekitio::SelectedFieldsSchemaItem] },
155155
api_name: :selectedFieldsSchema
156156

157157
# @!attribute size
@@ -183,8 +183,8 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
183183
# @!attribute version_info
184184
# An object containing the file or file version's `id` (versionId) and `name`.
185185
#
186-
# @return [Imagekitio::Models::FileUploadResponse::VersionInfo, nil]
187-
optional :version_info, -> { Imagekitio::Models::FileUploadResponse::VersionInfo }, api_name: :versionInfo
186+
# @return [Imagekitio::Models::VersionInfo, nil]
187+
optional :version_info, -> { Imagekitio::VersionInfo }, api_name: :versionInfo
188188

189189
# @!attribute video_codec
190190
# The video codec used in the video (only for video).
@@ -204,7 +204,7 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
204204
#
205205
# Object containing details of a successful upload.
206206
#
207-
# @param ai_tags [Array<Imagekitio::Models::FileUploadResponse::AITag>, nil] An array of tags assigned to the uploaded file by auto tagging.
207+
# @param ai_tags [Array<Imagekitio::Models::AITag>, nil] An array of tags assigned to the uploaded file by auto tagging.
208208
#
209209
# @param audio_codec [String] The audio codec used in the video (only for video).
210210
#
@@ -238,7 +238,7 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
238238
#
239239
# @param name [String] Name of the asset.
240240
#
241-
# @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
241+
# @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}] This field is included in the response only if the Path policy feature is availa
242242
#
243243
# @param size [Float] Size of the image file in Bytes.
244244
#
@@ -248,7 +248,7 @@ class FileUploadResponse < Imagekitio::Internal::Type::BaseModel
248248
#
249249
# @param url [String] A publicly accessible URL of the file.
250250
#
251-
# @param version_info [Imagekitio::Models::FileUploadResponse::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`.
251+
# @param version_info [Imagekitio::Models::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`.
252252
#
253253
# @param video_codec [String] The video codec used in the video (only for video).
254254
#

0 commit comments

Comments
 (0)