Skip to content

Commit 0ac922a

Browse files
feat(api): fix upload API request params
1 parent c16e257 commit 0ac922a

24 files changed

+2476
-1680
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 42
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-aa4c8e857ae03b12dabf168c83c62f759e2706d69fa4eb77d11519d45a5dada2.yml
3-
openapi_spec_hash: 6ea00242c4685fb6422328f0dd53f9b1
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-01aef94bd928f40b7209dc21df71e2312d4bee430119b30ee05d75cf5e1b4801.yml
3+
openapi_spec_hash: 054c332db88b23d362f72583dd24b2aa
44
config_hash: e42d7fc3a8c92c35099cc283f9a4467a

lib/imagekit/models/beta/v2/file_upload_params.rb

Lines changed: 1 addition & 228 deletions
Original file line numberDiff line numberDiff line change
@@ -160,22 +160,6 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel
160160
},
161161
api_name: :responseFields
162162

163-
# @!attribute selected_fields_schema
164-
# This field is included in the response only if the Path policy feature is
165-
# available in the plan. It contains schema definitions for the custom metadata
166-
# fields selected for the specified file path. Field selection can only be done
167-
# when the Path policy feature is enabled.
168-
#
169-
# Keys are the names of the custom metadata fields; the value object has details
170-
# about the custom metadata schema.
171-
#
172-
# @return [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema}, nil]
173-
optional :selected_fields_schema,
174-
-> {
175-
Imagekit::Internal::Type::HashOf[Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema]
176-
},
177-
api_name: :selectedFieldsSchema
178-
179163
# @!attribute tags
180164
# Set the tags while uploading the file. Provide an array of tag strings (e.g.
181165
# `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not
@@ -222,7 +206,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel
222206
# @return [String, nil]
223207
optional :webhook_url, String, api_name: :webhookUrl
224208

225-
# @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, selected_fields_schema: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {})
209+
# @!method initialize(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, response_fields: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {})
226210
# Some parameter documentations has been truncated, see
227211
# {Imagekit::Models::Beta::V2::FileUploadParams} for more details.
228212
#
@@ -258,8 +242,6 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel
258242
#
259243
# @param response_fields [Array<Symbol, Imagekit::Models::Beta::V2::FileUploadParams::ResponseField>] Array of response field keys to include in the API response body.
260244
#
261-
# @param selected_fields_schema [Hash{Symbol=>Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema}] This field is included in the response only if the Path policy feature is availa
262-
#
263245
# @param tags [Array<String>] Set the tags while uploading the file.
264246
#
265247
# @param transformation [Imagekit::Models::Beta::V2::FileUploadParams::Transformation] Configure pre-processing (`pre`) and post-processing (`post`) transformations.
@@ -286,215 +268,6 @@ module ResponseField
286268
# @return [Array<Symbol>]
287269
end
288270

289-
class SelectedFieldsSchema < Imagekit::Internal::Type::BaseModel
290-
# @!attribute type
291-
# Type of the custom metadata field.
292-
#
293-
# @return [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type]
294-
required :type, enum: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type }
295-
296-
# @!attribute default_value
297-
# The default value for this custom metadata field. The value should match the
298-
# `type` of custom metadata field.
299-
#
300-
# @return [String, Float, Boolean, Array<String, Float, Boolean>, nil]
301-
optional :default_value,
302-
union: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue },
303-
api_name: :defaultValue
304-
305-
# @!attribute is_value_required
306-
# Specifies if the custom metadata field is required or not.
307-
#
308-
# @return [Boolean, nil]
309-
optional :is_value_required, Imagekit::Internal::Type::Boolean, api_name: :isValueRequired
310-
311-
# @!attribute max_length
312-
# Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
313-
#
314-
# @return [Float, nil]
315-
optional :max_length, Float, api_name: :maxLength
316-
317-
# @!attribute max_value
318-
# Maximum value of the field. Only set if field type is `Date` or `Number`. For
319-
# `Date` type field, the value will be in ISO8601 string format. For `Number` type
320-
# field, it will be a numeric value.
321-
#
322-
# @return [String, Float, nil]
323-
optional :max_value,
324-
union: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MaxValue },
325-
api_name: :maxValue
326-
327-
# @!attribute min_length
328-
# Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
329-
#
330-
# @return [Float, nil]
331-
optional :min_length, Float, api_name: :minLength
332-
333-
# @!attribute min_value
334-
# Minimum value of the field. Only set if field type is `Date` or `Number`. For
335-
# `Date` type field, the value will be in ISO8601 string format. For `Number` type
336-
# field, it will be a numeric value.
337-
#
338-
# @return [String, Float, nil]
339-
optional :min_value,
340-
union: -> { Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::MinValue },
341-
api_name: :minValue
342-
343-
# @!attribute read_only
344-
# Indicates whether the custom metadata field is read only. A read only field
345-
# cannot be modified after being set. This field is configurable only via the
346-
# **Path policy** feature.
347-
#
348-
# @return [Boolean, nil]
349-
optional :read_only, Imagekit::Internal::Type::Boolean, api_name: :readOnly
350-
351-
# @!attribute select_options
352-
# An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
353-
#
354-
# @return [Array<String, Float, Boolean>, nil]
355-
optional :select_options,
356-
-> {
357-
Imagekit::Internal::Type::ArrayOf[union: Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::SelectOption]
358-
},
359-
api_name: :selectOptions
360-
361-
# @!attribute select_options_truncated
362-
# Specifies if the selectOptions array is truncated. It is truncated when number
363-
# of options are > 100.
364-
#
365-
# @return [Boolean, nil]
366-
optional :select_options_truncated,
367-
Imagekit::Internal::Type::Boolean,
368-
api_name: :selectOptionsTruncated
369-
370-
# @!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)
371-
# Some parameter documentations has been truncated, see
372-
# {Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema} for more
373-
# details.
374-
#
375-
# @param type [Symbol, Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::Type] Type of the custom metadata field.
376-
#
377-
# @param default_value [String, Float, Boolean, Array<String, Float, Boolean>] The default value for this custom metadata field. The value should match the `ty
378-
#
379-
# @param is_value_required [Boolean] Specifies if the custom metadata field is required or not.
380-
#
381-
# @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
382-
#
383-
# @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D
384-
#
385-
# @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
386-
#
387-
# @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D
388-
#
389-
# @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann
390-
#
391-
# @param select_options [Array<String, Float, Boolean>] An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
392-
#
393-
# @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o
394-
395-
# Type of the custom metadata field.
396-
#
397-
# @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#type
398-
module Type
399-
extend Imagekit::Internal::Type::Enum
400-
401-
TEXT = :Text
402-
TEXTAREA = :Textarea
403-
NUMBER = :Number
404-
DATE = :Date
405-
BOOLEAN = :Boolean
406-
SINGLE_SELECT = :SingleSelect
407-
MULTI_SELECT = :MultiSelect
408-
409-
# @!method self.values
410-
# @return [Array<Symbol>]
411-
end
412-
413-
# The default value for this custom metadata field. The value should match the
414-
# `type` of custom metadata field.
415-
#
416-
# @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#default_value
417-
module DefaultValue
418-
extend Imagekit::Internal::Type::Union
419-
420-
variant String
421-
422-
variant Float
423-
424-
variant Imagekit::Internal::Type::Boolean
425-
426-
# Default value should be of type array when custom metadata field type is set to `MultiSelect`.
427-
variant -> { Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::MixedArray }
428-
429-
module Mixed
430-
extend Imagekit::Internal::Type::Union
431-
432-
variant String
433-
434-
variant Float
435-
436-
variant Imagekit::Internal::Type::Boolean
437-
438-
# @!method self.variants
439-
# @return [Array(String, Float, Boolean)]
440-
end
441-
442-
# @!method self.variants
443-
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
444-
445-
# @type [Imagekit::Internal::Type::Converter]
446-
MixedArray =
447-
Imagekit::Internal::Type::ArrayOf[union: -> {
448-
Imagekit::Beta::V2::FileUploadParams::SelectedFieldsSchema::DefaultValue::Mixed
449-
}]
450-
end
451-
452-
# Maximum value of the field. Only set if field type is `Date` or `Number`. For
453-
# `Date` type field, the value will be in ISO8601 string format. For `Number` type
454-
# field, it will be a numeric value.
455-
#
456-
# @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#max_value
457-
module MaxValue
458-
extend Imagekit::Internal::Type::Union
459-
460-
variant String
461-
462-
variant Float
463-
464-
# @!method self.variants
465-
# @return [Array(String, Float)]
466-
end
467-
468-
# Minimum value of the field. Only set if field type is `Date` or `Number`. For
469-
# `Date` type field, the value will be in ISO8601 string format. For `Number` type
470-
# field, it will be a numeric value.
471-
#
472-
# @see Imagekit::Models::Beta::V2::FileUploadParams::SelectedFieldsSchema#min_value
473-
module MinValue
474-
extend Imagekit::Internal::Type::Union
475-
476-
variant String
477-
478-
variant Float
479-
480-
# @!method self.variants
481-
# @return [Array(String, Float)]
482-
end
483-
484-
module SelectOption
485-
extend Imagekit::Internal::Type::Union
486-
487-
variant String
488-
489-
variant Float
490-
491-
variant Imagekit::Internal::Type::Boolean
492-
493-
# @!method self.variants
494-
# @return [Array(String, Float, Boolean)]
495-
end
496-
end
497-
498271
class Transformation < Imagekit::Internal::Type::BaseModel
499272
# @!attribute post
500273
# List of transformations to apply _after_ the file is uploaded.

0 commit comments

Comments
 (0)