imagekitio 4.3.0 → 4.4.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 +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +9 -2
- data/lib/imagekitio/internal/type/base_model.rb +5 -5
- data/lib/imagekitio/internal/util.rb +3 -1
- data/lib/imagekitio/models/ai_tag.rb +39 -0
- data/lib/imagekitio/models/beta/v2/file_upload_response.rb +9 -270
- data/lib/imagekitio/models/custom_metadata.rb +8 -0
- data/lib/imagekitio/models/embedded_metadata.rb +8 -0
- data/lib/imagekitio/models/file.rb +11 -275
- data/lib/imagekitio/models/file_create_event.rb +34 -0
- data/lib/imagekitio/models/file_delete_event.rb +44 -0
- data/lib/imagekitio/models/file_update_event.rb +34 -0
- data/lib/imagekitio/models/file_upload_response.rb +9 -267
- data/lib/imagekitio/models/file_version_create_event.rb +34 -0
- data/lib/imagekitio/models/file_version_delete_event.rb +52 -0
- data/lib/imagekitio/models/selected_fields_schema.rb +212 -0
- data/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb +16 -1
- data/lib/imagekitio/models/unwrap_webhook_event.rb +16 -1
- data/lib/imagekitio/models/upload_pre_transform_success_event.rb +9 -285
- data/lib/imagekitio/models/version_info.rb +26 -0
- data/lib/imagekitio/models.rb +25 -0
- data/lib/imagekitio/resources/webhooks.rb +4 -3
- data/lib/imagekitio/version.rb +1 -1
- data/lib/imagekitio.rb +11 -1
- data/rbi/imagekitio/models/ai_tag.rbi +56 -0
- data/rbi/imagekitio/models/beta/v2/file_upload_response.rbi +11 -535
- data/rbi/imagekitio/models/custom_metadata.rbi +11 -0
- data/rbi/imagekitio/models/embedded_metadata.rbi +11 -0
- data/rbi/imagekitio/models/file.rbi +15 -475
- data/rbi/imagekitio/models/file_create_event.rbi +53 -0
- data/rbi/imagekitio/models/file_delete_event.rbi +80 -0
- data/rbi/imagekitio/models/file_update_event.rbi +53 -0
- data/rbi/imagekitio/models/file_upload_response.rbi +11 -520
- data/rbi/imagekitio/models/file_version_create_event.rbi +56 -0
- data/rbi/imagekitio/models/file_version_delete_event.rbi +93 -0
- data/rbi/imagekitio/models/selected_fields_schema.rbi +364 -0
- data/rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi +6 -1
- data/rbi/imagekitio/models/unwrap_webhook_event.rbi +6 -1
- data/rbi/imagekitio/models/upload_pre_transform_success_event.rbi +11 -533
- data/rbi/imagekitio/models/version_info.rbi +40 -0
- data/rbi/imagekitio/models.rbi +34 -0
- data/rbi/imagekitio/resources/webhooks.rbi +12 -2
- data/sig/imagekitio/models/ai_tag.rbs +27 -0
- data/sig/imagekitio/models/beta/v2/file_upload_response.rbs +30 -223
- data/sig/imagekitio/models/custom_metadata.rbs +7 -0
- data/sig/imagekitio/models/embedded_metadata.rbs +7 -0
- data/sig/imagekitio/models/file.rbs +29 -224
- data/sig/imagekitio/models/file_create_event.rbs +32 -0
- data/sig/imagekitio/models/file_delete_event.rbs +48 -0
- data/sig/imagekitio/models/file_update_event.rbs +32 -0
- data/sig/imagekitio/models/file_upload_response.rbs +29 -224
- data/sig/imagekitio/models/file_version_create_event.rbs +36 -0
- data/sig/imagekitio/models/file_version_delete_event.rbs +50 -0
- data/sig/imagekitio/models/selected_fields_schema.rbs +165 -0
- data/sig/imagekitio/models/unsafe_unwrap_webhook_event.rbs +5 -0
- data/sig/imagekitio/models/unwrap_webhook_event.rbs +5 -0
- data/sig/imagekitio/models/upload_pre_transform_success_event.rbs +29 -224
- data/sig/imagekitio/models/version_info.rbs +19 -0
- data/sig/imagekitio/models.rbs +22 -0
- data/sig/imagekitio/resources/webhooks.rbs +12 -2
- metadata +32 -2
|
@@ -42,11 +42,9 @@ module Imagekitio
|
|
|
42
42
|
# @!attribute ai_tags
|
|
43
43
|
# An array of tags assigned to the uploaded file by auto tagging.
|
|
44
44
|
#
|
|
45
|
-
# @return [Array<Imagekitio::Models::
|
|
45
|
+
# @return [Array<Imagekitio::Models::AITag>, nil]
|
|
46
46
|
optional :ai_tags,
|
|
47
|
-
-> {
|
|
48
|
-
Imagekitio::Internal::Type::ArrayOf[Imagekitio::UploadPreTransformSuccessEvent::Data::AITag]
|
|
49
|
-
},
|
|
47
|
+
-> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::AITag] },
|
|
50
48
|
api_name: :AITags,
|
|
51
49
|
nil?: true
|
|
52
50
|
|
|
@@ -186,11 +184,9 @@ module Imagekitio
|
|
|
186
184
|
# Keys are the names of the custom metadata fields; the value object has details
|
|
187
185
|
# about the custom metadata schema.
|
|
188
186
|
#
|
|
189
|
-
# @return [Hash{Symbol=>Imagekitio::Models::
|
|
187
|
+
# @return [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}, nil]
|
|
190
188
|
optional :selected_fields_schema,
|
|
191
|
-
-> {
|
|
192
|
-
Imagekitio::Internal::Type::HashOf[Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema]
|
|
193
|
-
},
|
|
189
|
+
-> { Imagekitio::Internal::Type::HashOf[Imagekitio::SelectedFieldsSchemaItem] },
|
|
194
190
|
api_name: :selectedFieldsSchema
|
|
195
191
|
|
|
196
192
|
# @!attribute size
|
|
@@ -222,10 +218,8 @@ module Imagekitio
|
|
|
222
218
|
# @!attribute version_info
|
|
223
219
|
# An object containing the file or file version's `id` (versionId) and `name`.
|
|
224
220
|
#
|
|
225
|
-
# @return [Imagekitio::Models::
|
|
226
|
-
optional :version_info,
|
|
227
|
-
-> { Imagekitio::UploadPreTransformSuccessEvent::Data::VersionInfo },
|
|
228
|
-
api_name: :versionInfo
|
|
221
|
+
# @return [Imagekitio::Models::VersionInfo, nil]
|
|
222
|
+
optional :version_info, -> { Imagekitio::VersionInfo }, api_name: :versionInfo
|
|
229
223
|
|
|
230
224
|
# @!attribute video_codec
|
|
231
225
|
# The video codec used in the video (only for video).
|
|
@@ -245,7 +239,7 @@ module Imagekitio
|
|
|
245
239
|
#
|
|
246
240
|
# Object containing details of a successful upload.
|
|
247
241
|
#
|
|
248
|
-
# @param ai_tags [Array<Imagekitio::Models::
|
|
242
|
+
# @param ai_tags [Array<Imagekitio::Models::AITag>, nil] An array of tags assigned to the uploaded file by auto tagging.
|
|
249
243
|
#
|
|
250
244
|
# @param audio_codec [String] The audio codec used in the video (only for video).
|
|
251
245
|
#
|
|
@@ -279,7 +273,7 @@ module Imagekitio
|
|
|
279
273
|
#
|
|
280
274
|
# @param name [String] Name of the asset.
|
|
281
275
|
#
|
|
282
|
-
# @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::
|
|
276
|
+
# @param selected_fields_schema [Hash{Symbol=>Imagekitio::Models::SelectedFieldsSchemaItem}] This field is included in the response only if the Path policy feature is availa
|
|
283
277
|
#
|
|
284
278
|
# @param size [Float] Size of the image file in Bytes.
|
|
285
279
|
#
|
|
@@ -289,45 +283,12 @@ module Imagekitio
|
|
|
289
283
|
#
|
|
290
284
|
# @param url [String] A publicly accessible URL of the file.
|
|
291
285
|
#
|
|
292
|
-
# @param version_info [Imagekitio::Models::
|
|
286
|
+
# @param version_info [Imagekitio::Models::VersionInfo] An object containing the file or file version's `id` (versionId) and `name`.
|
|
293
287
|
#
|
|
294
288
|
# @param video_codec [String] The video codec used in the video (only for video).
|
|
295
289
|
#
|
|
296
290
|
# @param width [Float] Width of the image in pixels (Only for Images)
|
|
297
291
|
|
|
298
|
-
class AITag < Imagekitio::Internal::Type::BaseModel
|
|
299
|
-
# @!attribute confidence
|
|
300
|
-
# Confidence score of the tag.
|
|
301
|
-
#
|
|
302
|
-
# @return [Float, nil]
|
|
303
|
-
optional :confidence, Float
|
|
304
|
-
|
|
305
|
-
# @!attribute name
|
|
306
|
-
# Name of the tag.
|
|
307
|
-
#
|
|
308
|
-
# @return [String, nil]
|
|
309
|
-
optional :name, String
|
|
310
|
-
|
|
311
|
-
# @!attribute source
|
|
312
|
-
# Array of `AITags` associated with the image. If no `AITags` are set, it will be
|
|
313
|
-
# null. These tags can be added using the `google-auto-tagging` or
|
|
314
|
-
# `aws-auto-tagging` extensions.
|
|
315
|
-
#
|
|
316
|
-
# @return [String, nil]
|
|
317
|
-
optional :source, String
|
|
318
|
-
|
|
319
|
-
# @!method initialize(confidence: nil, name: nil, source: nil)
|
|
320
|
-
# Some parameter documentations has been truncated, see
|
|
321
|
-
# {Imagekitio::Models::UploadPreTransformSuccessEvent::Data::AITag} for more
|
|
322
|
-
# details.
|
|
323
|
-
#
|
|
324
|
-
# @param confidence [Float] Confidence score of the tag.
|
|
325
|
-
#
|
|
326
|
-
# @param name [String] Name of the tag.
|
|
327
|
-
#
|
|
328
|
-
# @param source [String] Array of `AITags` associated with the image. If no `AITags` are set, it will be
|
|
329
|
-
end
|
|
330
|
-
|
|
331
292
|
# @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data#extension_status
|
|
332
293
|
class ExtensionStatus < Imagekitio::Internal::Type::BaseModel
|
|
333
294
|
# @!attribute ai_auto_description
|
|
@@ -448,243 +409,6 @@ module Imagekitio
|
|
|
448
409
|
# @return [Array<Symbol>]
|
|
449
410
|
end
|
|
450
411
|
end
|
|
451
|
-
|
|
452
|
-
class SelectedFieldsSchema < Imagekitio::Internal::Type::BaseModel
|
|
453
|
-
# @!attribute type
|
|
454
|
-
# Type of the custom metadata field.
|
|
455
|
-
#
|
|
456
|
-
# @return [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type]
|
|
457
|
-
required :type, enum: -> { Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type }
|
|
458
|
-
|
|
459
|
-
# @!attribute default_value
|
|
460
|
-
# The default value for this custom metadata field. The value should match the
|
|
461
|
-
# `type` of custom metadata field.
|
|
462
|
-
#
|
|
463
|
-
# @return [String, Float, Boolean, Array<String, Float, Boolean>, nil]
|
|
464
|
-
optional :default_value,
|
|
465
|
-
union: -> {
|
|
466
|
-
Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue
|
|
467
|
-
},
|
|
468
|
-
api_name: :defaultValue
|
|
469
|
-
|
|
470
|
-
# @!attribute is_value_required
|
|
471
|
-
# Specifies if the custom metadata field is required or not.
|
|
472
|
-
#
|
|
473
|
-
# @return [Boolean, nil]
|
|
474
|
-
optional :is_value_required, Imagekitio::Internal::Type::Boolean, api_name: :isValueRequired
|
|
475
|
-
|
|
476
|
-
# @!attribute max_length
|
|
477
|
-
# Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
478
|
-
#
|
|
479
|
-
# @return [Float, nil]
|
|
480
|
-
optional :max_length, Float, api_name: :maxLength
|
|
481
|
-
|
|
482
|
-
# @!attribute max_value
|
|
483
|
-
# Maximum value of the field. Only set if field type is `Date` or `Number`. For
|
|
484
|
-
# `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
485
|
-
# field, it will be a numeric value.
|
|
486
|
-
#
|
|
487
|
-
# @return [String, Float, nil]
|
|
488
|
-
optional :max_value,
|
|
489
|
-
union: -> {
|
|
490
|
-
Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MaxValue
|
|
491
|
-
},
|
|
492
|
-
api_name: :maxValue
|
|
493
|
-
|
|
494
|
-
# @!attribute min_length
|
|
495
|
-
# Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
496
|
-
#
|
|
497
|
-
# @return [Float, nil]
|
|
498
|
-
optional :min_length, Float, api_name: :minLength
|
|
499
|
-
|
|
500
|
-
# @!attribute min_value
|
|
501
|
-
# Minimum value of the field. Only set if field type is `Date` or `Number`. For
|
|
502
|
-
# `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
503
|
-
# field, it will be a numeric value.
|
|
504
|
-
#
|
|
505
|
-
# @return [String, Float, nil]
|
|
506
|
-
optional :min_value,
|
|
507
|
-
union: -> {
|
|
508
|
-
Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::MinValue
|
|
509
|
-
},
|
|
510
|
-
api_name: :minValue
|
|
511
|
-
|
|
512
|
-
# @!attribute read_only
|
|
513
|
-
# Indicates whether the custom metadata field is read only. A read only field
|
|
514
|
-
# cannot be modified after being set. This field is configurable only via the
|
|
515
|
-
# **Path policy** feature.
|
|
516
|
-
#
|
|
517
|
-
# @return [Boolean, nil]
|
|
518
|
-
optional :read_only, Imagekitio::Internal::Type::Boolean, api_name: :readOnly
|
|
519
|
-
|
|
520
|
-
# @!attribute select_options
|
|
521
|
-
# An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
|
|
522
|
-
#
|
|
523
|
-
# @return [Array<String, Float, Boolean>, nil]
|
|
524
|
-
optional :select_options,
|
|
525
|
-
-> {
|
|
526
|
-
Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::SelectOption]
|
|
527
|
-
},
|
|
528
|
-
api_name: :selectOptions
|
|
529
|
-
|
|
530
|
-
# @!attribute select_options_truncated
|
|
531
|
-
# Specifies if the selectOptions array is truncated. It is truncated when number
|
|
532
|
-
# of options are > 100.
|
|
533
|
-
#
|
|
534
|
-
# @return [Boolean, nil]
|
|
535
|
-
optional :select_options_truncated,
|
|
536
|
-
Imagekitio::Internal::Type::Boolean,
|
|
537
|
-
api_name: :selectOptionsTruncated
|
|
538
|
-
|
|
539
|
-
# @!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)
|
|
540
|
-
# Some parameter documentations has been truncated, see
|
|
541
|
-
# {Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema}
|
|
542
|
-
# for more details.
|
|
543
|
-
#
|
|
544
|
-
# @param type [Symbol, Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::Type] Type of the custom metadata field.
|
|
545
|
-
#
|
|
546
|
-
# @param default_value [String, Float, Boolean, Array<String, Float, Boolean>] The default value for this custom metadata field. The value should match the `ty
|
|
547
|
-
#
|
|
548
|
-
# @param is_value_required [Boolean] Specifies if the custom metadata field is required or not.
|
|
549
|
-
#
|
|
550
|
-
# @param max_length [Float] Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
551
|
-
#
|
|
552
|
-
# @param max_value [String, Float] Maximum value of the field. Only set if field type is `Date` or `Number`. For `D
|
|
553
|
-
#
|
|
554
|
-
# @param min_length [Float] Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
|
|
555
|
-
#
|
|
556
|
-
# @param min_value [String, Float] Minimum value of the field. Only set if field type is `Date` or `Number`. For `D
|
|
557
|
-
#
|
|
558
|
-
# @param read_only [Boolean] Indicates whether the custom metadata field is read only. A read only field cann
|
|
559
|
-
#
|
|
560
|
-
# @param select_options [Array<String, Float, Boolean>] An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
|
|
561
|
-
#
|
|
562
|
-
# @param select_options_truncated [Boolean] Specifies if the selectOptions array is truncated. It is truncated when number o
|
|
563
|
-
|
|
564
|
-
# Type of the custom metadata field.
|
|
565
|
-
#
|
|
566
|
-
# @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#type
|
|
567
|
-
module Type
|
|
568
|
-
extend Imagekitio::Internal::Type::Enum
|
|
569
|
-
|
|
570
|
-
TEXT = :Text
|
|
571
|
-
TEXTAREA = :Textarea
|
|
572
|
-
NUMBER = :Number
|
|
573
|
-
DATE = :Date
|
|
574
|
-
BOOLEAN = :Boolean
|
|
575
|
-
SINGLE_SELECT = :SingleSelect
|
|
576
|
-
MULTI_SELECT = :MultiSelect
|
|
577
|
-
|
|
578
|
-
# @!method self.values
|
|
579
|
-
# @return [Array<Symbol>]
|
|
580
|
-
end
|
|
581
|
-
|
|
582
|
-
# The default value for this custom metadata field. The value should match the
|
|
583
|
-
# `type` of custom metadata field.
|
|
584
|
-
#
|
|
585
|
-
# @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#default_value
|
|
586
|
-
module DefaultValue
|
|
587
|
-
extend Imagekitio::Internal::Type::Union
|
|
588
|
-
|
|
589
|
-
variant String
|
|
590
|
-
|
|
591
|
-
variant Float
|
|
592
|
-
|
|
593
|
-
variant Imagekitio::Internal::Type::Boolean
|
|
594
|
-
|
|
595
|
-
# Default value should be of type array when custom metadata field type is set to `MultiSelect`.
|
|
596
|
-
variant -> { Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::MixedArray }
|
|
597
|
-
|
|
598
|
-
module Mixed
|
|
599
|
-
extend Imagekitio::Internal::Type::Union
|
|
600
|
-
|
|
601
|
-
variant String
|
|
602
|
-
|
|
603
|
-
variant Float
|
|
604
|
-
|
|
605
|
-
variant Imagekitio::Internal::Type::Boolean
|
|
606
|
-
|
|
607
|
-
# @!method self.variants
|
|
608
|
-
# @return [Array(String, Float, Boolean)]
|
|
609
|
-
end
|
|
610
|
-
|
|
611
|
-
# @!method self.variants
|
|
612
|
-
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
613
|
-
|
|
614
|
-
# @type [Imagekitio::Internal::Type::Converter]
|
|
615
|
-
MixedArray =
|
|
616
|
-
Imagekitio::Internal::Type::ArrayOf[union: -> {
|
|
617
|
-
Imagekitio::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema::DefaultValue::Mixed
|
|
618
|
-
}]
|
|
619
|
-
end
|
|
620
|
-
|
|
621
|
-
# Maximum value of the field. Only set if field type is `Date` or `Number`. For
|
|
622
|
-
# `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
623
|
-
# field, it will be a numeric value.
|
|
624
|
-
#
|
|
625
|
-
# @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#max_value
|
|
626
|
-
module MaxValue
|
|
627
|
-
extend Imagekitio::Internal::Type::Union
|
|
628
|
-
|
|
629
|
-
variant String
|
|
630
|
-
|
|
631
|
-
variant Float
|
|
632
|
-
|
|
633
|
-
# @!method self.variants
|
|
634
|
-
# @return [Array(String, Float)]
|
|
635
|
-
end
|
|
636
|
-
|
|
637
|
-
# Minimum value of the field. Only set if field type is `Date` or `Number`. For
|
|
638
|
-
# `Date` type field, the value will be in ISO8601 string format. For `Number` type
|
|
639
|
-
# field, it will be a numeric value.
|
|
640
|
-
#
|
|
641
|
-
# @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data::SelectedFieldsSchema#min_value
|
|
642
|
-
module MinValue
|
|
643
|
-
extend Imagekitio::Internal::Type::Union
|
|
644
|
-
|
|
645
|
-
variant String
|
|
646
|
-
|
|
647
|
-
variant Float
|
|
648
|
-
|
|
649
|
-
# @!method self.variants
|
|
650
|
-
# @return [Array(String, Float)]
|
|
651
|
-
end
|
|
652
|
-
|
|
653
|
-
module SelectOption
|
|
654
|
-
extend Imagekitio::Internal::Type::Union
|
|
655
|
-
|
|
656
|
-
variant String
|
|
657
|
-
|
|
658
|
-
variant Float
|
|
659
|
-
|
|
660
|
-
variant Imagekitio::Internal::Type::Boolean
|
|
661
|
-
|
|
662
|
-
# @!method self.variants
|
|
663
|
-
# @return [Array(String, Float, Boolean)]
|
|
664
|
-
end
|
|
665
|
-
end
|
|
666
|
-
|
|
667
|
-
# @see Imagekitio::Models::UploadPreTransformSuccessEvent::Data#version_info
|
|
668
|
-
class VersionInfo < Imagekitio::Internal::Type::BaseModel
|
|
669
|
-
# @!attribute id
|
|
670
|
-
# Unique identifier of the file version.
|
|
671
|
-
#
|
|
672
|
-
# @return [String, nil]
|
|
673
|
-
optional :id, String
|
|
674
|
-
|
|
675
|
-
# @!attribute name
|
|
676
|
-
# Name of the file version.
|
|
677
|
-
#
|
|
678
|
-
# @return [String, nil]
|
|
679
|
-
optional :name, String
|
|
680
|
-
|
|
681
|
-
# @!method initialize(id: nil, name: nil)
|
|
682
|
-
# An object containing the file or file version's `id` (versionId) and `name`.
|
|
683
|
-
#
|
|
684
|
-
# @param id [String] Unique identifier of the file version.
|
|
685
|
-
#
|
|
686
|
-
# @param name [String] Name of the file version.
|
|
687
|
-
end
|
|
688
412
|
end
|
|
689
413
|
|
|
690
414
|
class Request < Imagekitio::Internal::Type::BaseModel
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Models
|
|
5
|
+
class VersionInfo < Imagekitio::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# Unique identifier of the file version.
|
|
8
|
+
#
|
|
9
|
+
# @return [String, nil]
|
|
10
|
+
optional :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute name
|
|
13
|
+
# Name of the file version.
|
|
14
|
+
#
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
optional :name, String
|
|
17
|
+
|
|
18
|
+
# @!method initialize(id: nil, name: nil)
|
|
19
|
+
# An object containing the file or file version's `id` (versionId) and `name`.
|
|
20
|
+
#
|
|
21
|
+
# @param id [String] Unique identifier of the file version.
|
|
22
|
+
#
|
|
23
|
+
# @param name [String] Name of the file version.
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
data/lib/imagekitio/models.rb
CHANGED
|
@@ -41,6 +41,8 @@ module Imagekitio
|
|
|
41
41
|
|
|
42
42
|
Accounts = Imagekitio::Models::Accounts
|
|
43
43
|
|
|
44
|
+
AITag = Imagekitio::Models::AITag
|
|
45
|
+
|
|
44
46
|
AssetListParams = Imagekitio::Models::AssetListParams
|
|
45
47
|
|
|
46
48
|
BaseOverlay = Imagekitio::Models::BaseOverlay
|
|
@@ -51,6 +53,9 @@ module Imagekitio
|
|
|
51
53
|
|
|
52
54
|
Cache = Imagekitio::Models::Cache
|
|
53
55
|
|
|
56
|
+
# @type [Imagekitio::Internal::Type::Converter]
|
|
57
|
+
CustomMetadata = Imagekitio::Models::CustomMetadata
|
|
58
|
+
|
|
54
59
|
CustomMetadataField = Imagekitio::Models::CustomMetadataField
|
|
55
60
|
|
|
56
61
|
CustomMetadataFieldCreateParams = Imagekitio::Models::CustomMetadataFieldCreateParams
|
|
@@ -61,6 +66,9 @@ module Imagekitio
|
|
|
61
66
|
|
|
62
67
|
CustomMetadataFieldUpdateParams = Imagekitio::Models::CustomMetadataFieldUpdateParams
|
|
63
68
|
|
|
69
|
+
# @type [Imagekitio::Internal::Type::Converter]
|
|
70
|
+
EmbeddedMetadata = Imagekitio::Models::EmbeddedMetadata
|
|
71
|
+
|
|
64
72
|
ExtensionConfig = Imagekitio::Models::ExtensionConfig
|
|
65
73
|
|
|
66
74
|
ExtensionItem = Imagekitio::Models::ExtensionItem
|
|
@@ -72,6 +80,10 @@ module Imagekitio
|
|
|
72
80
|
|
|
73
81
|
FileCopyParams = Imagekitio::Models::FileCopyParams
|
|
74
82
|
|
|
83
|
+
FileCreateEvent = Imagekitio::Models::FileCreateEvent
|
|
84
|
+
|
|
85
|
+
FileDeleteEvent = Imagekitio::Models::FileDeleteEvent
|
|
86
|
+
|
|
75
87
|
FileDeleteParams = Imagekitio::Models::FileDeleteParams
|
|
76
88
|
|
|
77
89
|
FileGetParams = Imagekitio::Models::FileGetParams
|
|
@@ -82,10 +94,16 @@ module Imagekitio
|
|
|
82
94
|
|
|
83
95
|
Files = Imagekitio::Models::Files
|
|
84
96
|
|
|
97
|
+
FileUpdateEvent = Imagekitio::Models::FileUpdateEvent
|
|
98
|
+
|
|
85
99
|
FileUpdateParams = Imagekitio::Models::FileUpdateParams
|
|
86
100
|
|
|
87
101
|
FileUploadParams = Imagekitio::Models::FileUploadParams
|
|
88
102
|
|
|
103
|
+
FileVersionCreateEvent = Imagekitio::Models::FileVersionCreateEvent
|
|
104
|
+
|
|
105
|
+
FileVersionDeleteEvent = Imagekitio::Models::FileVersionDeleteEvent
|
|
106
|
+
|
|
89
107
|
Folder = Imagekitio::Models::Folder
|
|
90
108
|
|
|
91
109
|
FolderCopyParams = Imagekitio::Models::FolderCopyParams
|
|
@@ -126,6 +144,11 @@ module Imagekitio
|
|
|
126
144
|
|
|
127
145
|
SavedExtensionUpdateParams = Imagekitio::Models::SavedExtensionUpdateParams
|
|
128
146
|
|
|
147
|
+
# @type [Imagekitio::Internal::Type::Converter]
|
|
148
|
+
SelectedFieldsSchema = Imagekitio::Models::SelectedFieldsSchema
|
|
149
|
+
|
|
150
|
+
SelectedFieldsSchemaItem = Imagekitio::Models::SelectedFieldsSchemaItem
|
|
151
|
+
|
|
129
152
|
SolidColorOverlay = Imagekitio::Models::SolidColorOverlay
|
|
130
153
|
|
|
131
154
|
SolidColorOverlayTransformation = Imagekitio::Models::SolidColorOverlayTransformation
|
|
@@ -160,6 +183,8 @@ module Imagekitio
|
|
|
160
183
|
|
|
161
184
|
UploadPreTransformSuccessEvent = Imagekitio::Models::UploadPreTransformSuccessEvent
|
|
162
185
|
|
|
186
|
+
VersionInfo = Imagekitio::Models::VersionInfo
|
|
187
|
+
|
|
163
188
|
VideoOverlay = Imagekitio::Models::VideoOverlay
|
|
164
189
|
|
|
165
190
|
VideoTransformationAcceptedEvent = Imagekitio::Models::VideoTransformationAcceptedEvent
|
|
@@ -5,7 +5,7 @@ module Imagekitio
|
|
|
5
5
|
class Webhooks
|
|
6
6
|
# @param payload [String] The raw webhook payload as a string
|
|
7
7
|
#
|
|
8
|
-
# @return [Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent]
|
|
8
|
+
# @return [Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent, Imagekitio::Models::FileCreateEvent, Imagekitio::Models::FileUpdateEvent, Imagekitio::Models::FileDeleteEvent, Imagekitio::Models::FileVersionCreateEvent, Imagekitio::Models::FileVersionDeleteEvent]
|
|
9
9
|
def unsafe_unwrap(payload)
|
|
10
10
|
parsed = JSON.parse(payload, symbolize_names: true)
|
|
11
11
|
Imagekitio::Internal::Type::Converter.coerce(Imagekitio::Models::UnsafeUnwrapWebhookEvent, parsed)
|
|
@@ -17,13 +17,14 @@ module Imagekitio
|
|
|
17
17
|
#
|
|
18
18
|
# @param key [String, nil] The webhook signing key
|
|
19
19
|
#
|
|
20
|
-
# @return [Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent]
|
|
20
|
+
# @return [Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent, Imagekitio::Models::FileCreateEvent, Imagekitio::Models::FileUpdateEvent, Imagekitio::Models::FileDeleteEvent, Imagekitio::Models::FileVersionCreateEvent, Imagekitio::Models::FileVersionDeleteEvent]
|
|
21
21
|
def unwrap(payload, headers:, key: @client.webhook_secret)
|
|
22
22
|
if key.nil?
|
|
23
23
|
raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_secret or passed in as an argument")
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
encoded_key = Base64.strict_encode64(key)
|
|
27
|
+
::StandardWebhooks::Webhook.new(encoded_key).verify(payload, headers)
|
|
27
28
|
|
|
28
29
|
parsed = JSON.parse(payload, symbolize_names: true)
|
|
29
30
|
Imagekitio::Internal::Type::Converter.coerce(Imagekitio::Models::UnwrapWebhookEvent, parsed)
|
data/lib/imagekitio/version.rb
CHANGED
data/lib/imagekitio.rb
CHANGED
|
@@ -55,11 +55,11 @@ require_relative "imagekitio/internal/transport/pooled_net_requester"
|
|
|
55
55
|
require_relative "imagekitio/client"
|
|
56
56
|
require_relative "imagekitio/models/accounts/origin_request"
|
|
57
57
|
require_relative "imagekitio/models/accounts/url_endpoint_request"
|
|
58
|
+
require_relative "imagekitio/models/base_webhook_event"
|
|
58
59
|
require_relative "imagekitio/models/update_file_request"
|
|
59
60
|
require_relative "imagekitio/models/file"
|
|
60
61
|
require_relative "imagekitio/models/src_options"
|
|
61
62
|
require_relative "imagekitio/models/base_overlay"
|
|
62
|
-
require_relative "imagekitio/models/base_webhook_event"
|
|
63
63
|
require_relative "imagekitio/models/accounts/origin_create_params"
|
|
64
64
|
require_relative "imagekitio/models/accounts/origin_delete_params"
|
|
65
65
|
require_relative "imagekitio/models/accounts/origin_get_params"
|
|
@@ -76,6 +76,7 @@ require_relative "imagekitio/models/accounts/url_endpoint_response"
|
|
|
76
76
|
require_relative "imagekitio/models/accounts/url_endpoint_update_params"
|
|
77
77
|
require_relative "imagekitio/models/accounts/usage_get_params"
|
|
78
78
|
require_relative "imagekitio/models/accounts/usage_get_response"
|
|
79
|
+
require_relative "imagekitio/models/ai_tag"
|
|
79
80
|
require_relative "imagekitio/models/asset_list_params"
|
|
80
81
|
require_relative "imagekitio/models/asset_list_response"
|
|
81
82
|
require_relative "imagekitio/models/beta/v2/file_upload_params"
|
|
@@ -84,6 +85,7 @@ require_relative "imagekitio/models/cache/invalidation_create_params"
|
|
|
84
85
|
require_relative "imagekitio/models/cache/invalidation_create_response"
|
|
85
86
|
require_relative "imagekitio/models/cache/invalidation_get_params"
|
|
86
87
|
require_relative "imagekitio/models/cache/invalidation_get_response"
|
|
88
|
+
require_relative "imagekitio/models/custom_metadata"
|
|
87
89
|
require_relative "imagekitio/models/custom_metadata_field"
|
|
88
90
|
require_relative "imagekitio/models/custom_metadata_field_create_params"
|
|
89
91
|
require_relative "imagekitio/models/custom_metadata_field_delete_params"
|
|
@@ -91,10 +93,13 @@ require_relative "imagekitio/models/custom_metadata_field_delete_response"
|
|
|
91
93
|
require_relative "imagekitio/models/custom_metadata_field_list_params"
|
|
92
94
|
require_relative "imagekitio/models/custom_metadata_field_list_response"
|
|
93
95
|
require_relative "imagekitio/models/custom_metadata_field_update_params"
|
|
96
|
+
require_relative "imagekitio/models/embedded_metadata"
|
|
94
97
|
require_relative "imagekitio/models/extension_config"
|
|
95
98
|
require_relative "imagekitio/models/extensions"
|
|
96
99
|
require_relative "imagekitio/models/file_copy_params"
|
|
97
100
|
require_relative "imagekitio/models/file_copy_response"
|
|
101
|
+
require_relative "imagekitio/models/file_create_event"
|
|
102
|
+
require_relative "imagekitio/models/file_delete_event"
|
|
98
103
|
require_relative "imagekitio/models/file_delete_params"
|
|
99
104
|
require_relative "imagekitio/models/file_get_params"
|
|
100
105
|
require_relative "imagekitio/models/file_move_params"
|
|
@@ -117,10 +122,13 @@ require_relative "imagekitio/models/files/version_get_params"
|
|
|
117
122
|
require_relative "imagekitio/models/files/version_list_params"
|
|
118
123
|
require_relative "imagekitio/models/files/version_list_response"
|
|
119
124
|
require_relative "imagekitio/models/files/version_restore_params"
|
|
125
|
+
require_relative "imagekitio/models/file_update_event"
|
|
120
126
|
require_relative "imagekitio/models/file_update_params"
|
|
121
127
|
require_relative "imagekitio/models/file_update_response"
|
|
122
128
|
require_relative "imagekitio/models/file_upload_params"
|
|
123
129
|
require_relative "imagekitio/models/file_upload_response"
|
|
130
|
+
require_relative "imagekitio/models/file_version_create_event"
|
|
131
|
+
require_relative "imagekitio/models/file_version_delete_event"
|
|
124
132
|
require_relative "imagekitio/models/folder"
|
|
125
133
|
require_relative "imagekitio/models/folder_copy_params"
|
|
126
134
|
require_relative "imagekitio/models/folder_copy_response"
|
|
@@ -148,6 +156,7 @@ require_relative "imagekitio/models/saved_extension_get_params"
|
|
|
148
156
|
require_relative "imagekitio/models/saved_extension_list_params"
|
|
149
157
|
require_relative "imagekitio/models/saved_extension_list_response"
|
|
150
158
|
require_relative "imagekitio/models/saved_extension_update_params"
|
|
159
|
+
require_relative "imagekitio/models/selected_fields_schema"
|
|
151
160
|
require_relative "imagekitio/models/solid_color_overlay"
|
|
152
161
|
require_relative "imagekitio/models/solid_color_overlay_transformation"
|
|
153
162
|
require_relative "imagekitio/models/streaming_resolution"
|
|
@@ -163,6 +172,7 @@ require_relative "imagekitio/models/upload_post_transform_error_event"
|
|
|
163
172
|
require_relative "imagekitio/models/upload_post_transform_success_event"
|
|
164
173
|
require_relative "imagekitio/models/upload_pre_transform_error_event"
|
|
165
174
|
require_relative "imagekitio/models/upload_pre_transform_success_event"
|
|
175
|
+
require_relative "imagekitio/models/version_info"
|
|
166
176
|
require_relative "imagekitio/models/video_overlay"
|
|
167
177
|
require_relative "imagekitio/models/video_transformation_accepted_event"
|
|
168
178
|
require_relative "imagekitio/models/video_transformation_error_event"
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Models
|
|
5
|
+
class AITag < Imagekitio::Internal::Type::BaseModel
|
|
6
|
+
OrHash =
|
|
7
|
+
T.type_alias { T.any(Imagekitio::AITag, Imagekitio::Internal::AnyHash) }
|
|
8
|
+
|
|
9
|
+
# Confidence score of the tag.
|
|
10
|
+
sig { returns(T.nilable(Float)) }
|
|
11
|
+
attr_reader :confidence
|
|
12
|
+
|
|
13
|
+
sig { params(confidence: Float).void }
|
|
14
|
+
attr_writer :confidence
|
|
15
|
+
|
|
16
|
+
# Name of the tag.
|
|
17
|
+
sig { returns(T.nilable(String)) }
|
|
18
|
+
attr_reader :name
|
|
19
|
+
|
|
20
|
+
sig { params(name: String).void }
|
|
21
|
+
attr_writer :name
|
|
22
|
+
|
|
23
|
+
# Source of the tag. Possible values are `google-auto-tagging` and
|
|
24
|
+
# `aws-auto-tagging`.
|
|
25
|
+
sig { returns(T.nilable(String)) }
|
|
26
|
+
attr_reader :source
|
|
27
|
+
|
|
28
|
+
sig { params(source: String).void }
|
|
29
|
+
attr_writer :source
|
|
30
|
+
|
|
31
|
+
# AI-generated tag associated with an image. These tags can be added using the
|
|
32
|
+
# `google-auto-tagging` or `aws-auto-tagging` extensions.
|
|
33
|
+
sig do
|
|
34
|
+
params(confidence: Float, name: String, source: String).returns(
|
|
35
|
+
T.attached_class
|
|
36
|
+
)
|
|
37
|
+
end
|
|
38
|
+
def self.new(
|
|
39
|
+
# Confidence score of the tag.
|
|
40
|
+
confidence: nil,
|
|
41
|
+
# Name of the tag.
|
|
42
|
+
name: nil,
|
|
43
|
+
# Source of the tag. Possible values are `google-auto-tagging` and
|
|
44
|
+
# `aws-auto-tagging`.
|
|
45
|
+
source: nil
|
|
46
|
+
)
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
sig do
|
|
50
|
+
override.returns({ confidence: Float, name: String, source: String })
|
|
51
|
+
end
|
|
52
|
+
def to_hash
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|