imagekitio 4.2.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.
Files changed (154) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +73 -0
  3. data/README.md +9 -2
  4. data/lib/imagekitio/client.rb +14 -0
  5. data/lib/imagekitio/helpers/helper.rb +6 -0
  6. data/lib/imagekitio/internal/transport/pooled_net_requester.rb +1 -1
  7. data/lib/imagekitio/internal/type/base_model.rb +5 -5
  8. data/lib/imagekitio/internal/util.rb +54 -8
  9. data/lib/imagekitio/models/accounts/origin_create_params.rb +1 -9
  10. data/lib/imagekitio/models/accounts/origin_delete_params.rb +13 -1
  11. data/lib/imagekitio/models/accounts/origin_get_params.rb +13 -1
  12. data/lib/imagekitio/models/accounts/origin_update_params.rb +10 -6
  13. data/lib/imagekitio/models/accounts/url_endpoint_delete_params.rb +14 -1
  14. data/lib/imagekitio/models/accounts/url_endpoint_get_params.rb +14 -1
  15. data/lib/imagekitio/models/accounts/url_endpoint_update_params.rb +14 -1
  16. data/lib/imagekitio/models/ai_tag.rb +39 -0
  17. data/lib/imagekitio/models/beta/v2/file_upload_response.rb +9 -270
  18. data/lib/imagekitio/models/cache/invalidation_get_params.rb +7 -1
  19. data/lib/imagekitio/models/custom_metadata.rb +8 -0
  20. data/lib/imagekitio/models/custom_metadata_field_delete_params.rb +7 -1
  21. data/lib/imagekitio/models/custom_metadata_field_update_params.rb +8 -1
  22. data/lib/imagekitio/models/embedded_metadata.rb +8 -0
  23. data/lib/imagekitio/models/extension_config.rb +10 -5
  24. data/lib/imagekitio/models/extensions.rb +10 -5
  25. data/lib/imagekitio/models/file.rb +11 -275
  26. data/lib/imagekitio/models/file_create_event.rb +34 -0
  27. data/lib/imagekitio/models/file_delete_event.rb +44 -0
  28. data/lib/imagekitio/models/file_delete_params.rb +7 -1
  29. data/lib/imagekitio/models/file_get_params.rb +7 -1
  30. data/lib/imagekitio/models/file_update_event.rb +34 -0
  31. data/lib/imagekitio/models/file_update_params.rb +5 -7
  32. data/lib/imagekitio/models/file_upload_response.rb +9 -267
  33. data/lib/imagekitio/models/file_version_create_event.rb +34 -0
  34. data/lib/imagekitio/models/file_version_delete_event.rb +52 -0
  35. data/lib/imagekitio/models/files/metadata_get_params.rb +7 -1
  36. data/lib/imagekitio/models/files/version_delete_params.rb +7 -1
  37. data/lib/imagekitio/models/files/version_get_params.rb +7 -1
  38. data/lib/imagekitio/models/files/version_list_params.rb +7 -1
  39. data/lib/imagekitio/models/files/version_restore_params.rb +7 -1
  40. data/lib/imagekitio/models/folders/job_get_params.rb +7 -1
  41. data/lib/imagekitio/models/overlay_position.rb +99 -5
  42. data/lib/imagekitio/models/saved_extension_delete_params.rb +7 -1
  43. data/lib/imagekitio/models/saved_extension_get_params.rb +7 -1
  44. data/lib/imagekitio/models/saved_extension_update_params.rb +8 -1
  45. data/lib/imagekitio/models/selected_fields_schema.rb +212 -0
  46. data/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb +16 -1
  47. data/lib/imagekitio/models/unwrap_webhook_event.rb +16 -1
  48. data/lib/imagekitio/models/upload_pre_transform_success_event.rb +9 -285
  49. data/lib/imagekitio/models/version_info.rb +26 -0
  50. data/lib/imagekitio/models.rb +25 -0
  51. data/lib/imagekitio/resources/accounts/origins.rb +4 -14
  52. data/lib/imagekitio/resources/accounts/usage.rb +2 -1
  53. data/lib/imagekitio/resources/assets.rb +2 -1
  54. data/lib/imagekitio/resources/beta/v2/files.rb +5 -4
  55. data/lib/imagekitio/resources/custom_metadata_fields.rb +2 -1
  56. data/lib/imagekitio/resources/files/metadata.rb +2 -1
  57. data/lib/imagekitio/resources/files.rb +7 -11
  58. data/lib/imagekitio/resources/webhooks.rb +14 -3
  59. data/lib/imagekitio/version.rb +1 -1
  60. data/lib/imagekitio.rb +12 -1
  61. data/rbi/imagekitio/client.rbi +13 -0
  62. data/rbi/imagekitio/internal/util.rbi +29 -1
  63. data/rbi/imagekitio/models/accounts/origin_create_params.rbi +4 -51
  64. data/rbi/imagekitio/models/accounts/origin_delete_params.rbi +18 -5
  65. data/rbi/imagekitio/models/accounts/origin_get_params.rbi +18 -5
  66. data/rbi/imagekitio/models/accounts/origin_update_params.rbi +9 -43
  67. data/rbi/imagekitio/models/accounts/url_endpoint_delete_params.rbi +20 -5
  68. data/rbi/imagekitio/models/accounts/url_endpoint_get_params.rbi +20 -5
  69. data/rbi/imagekitio/models/accounts/url_endpoint_update_params.rbi +20 -5
  70. data/rbi/imagekitio/models/ai_tag.rbi +56 -0
  71. data/rbi/imagekitio/models/beta/v2/file_upload_response.rbi +11 -535
  72. data/rbi/imagekitio/models/cache/invalidation_get_params.rbi +11 -5
  73. data/rbi/imagekitio/models/custom_metadata.rbi +11 -0
  74. data/rbi/imagekitio/models/custom_metadata_field_delete_params.rbi +13 -5
  75. data/rbi/imagekitio/models/custom_metadata_field_update_params.rbi +6 -0
  76. data/rbi/imagekitio/models/embedded_metadata.rbi +11 -0
  77. data/rbi/imagekitio/models/extension_config.rbi +16 -6
  78. data/rbi/imagekitio/models/extensions.rbi +16 -6
  79. data/rbi/imagekitio/models/file.rbi +15 -475
  80. data/rbi/imagekitio/models/file_create_event.rbi +53 -0
  81. data/rbi/imagekitio/models/file_delete_event.rbi +80 -0
  82. data/rbi/imagekitio/models/file_delete_params.rbi +13 -5
  83. data/rbi/imagekitio/models/file_get_params.rbi +13 -5
  84. data/rbi/imagekitio/models/file_update_event.rbi +53 -0
  85. data/rbi/imagekitio/models/file_update_params.rbi +5 -28
  86. data/rbi/imagekitio/models/file_upload_response.rbi +11 -520
  87. data/rbi/imagekitio/models/file_version_create_event.rbi +56 -0
  88. data/rbi/imagekitio/models/file_version_delete_event.rbi +93 -0
  89. data/rbi/imagekitio/models/files/metadata_get_params.rbi +11 -5
  90. data/rbi/imagekitio/models/files/version_delete_params.rbi +10 -2
  91. data/rbi/imagekitio/models/files/version_get_params.rbi +10 -2
  92. data/rbi/imagekitio/models/files/version_list_params.rbi +11 -5
  93. data/rbi/imagekitio/models/files/version_restore_params.rbi +10 -2
  94. data/rbi/imagekitio/models/folders/job_get_params.rbi +11 -5
  95. data/rbi/imagekitio/models/overlay_position.rbi +165 -9
  96. data/rbi/imagekitio/models/saved_extension_delete_params.rbi +13 -5
  97. data/rbi/imagekitio/models/saved_extension_get_params.rbi +13 -5
  98. data/rbi/imagekitio/models/saved_extension_update_params.rbi +6 -0
  99. data/rbi/imagekitio/models/selected_fields_schema.rbi +364 -0
  100. data/rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi +6 -1
  101. data/rbi/imagekitio/models/unwrap_webhook_event.rbi +6 -1
  102. data/rbi/imagekitio/models/upload_pre_transform_success_event.rbi +11 -533
  103. data/rbi/imagekitio/models/version_info.rbi +40 -0
  104. data/rbi/imagekitio/models.rbi +34 -0
  105. data/rbi/imagekitio/resources/accounts/origins.rbi +22 -2
  106. data/rbi/imagekitio/resources/beta/v2/files.rbi +5 -4
  107. data/rbi/imagekitio/resources/files.rbi +10 -5
  108. data/rbi/imagekitio/resources/webhooks.rbi +22 -4
  109. data/sig/imagekitio/client.rbs +3 -0
  110. data/sig/imagekitio/internal/util.rbs +14 -0
  111. data/sig/imagekitio/models/accounts/origin_create_params.rbs +3 -16
  112. data/sig/imagekitio/models/accounts/origin_delete_params.rbs +11 -3
  113. data/sig/imagekitio/models/accounts/origin_get_params.rbs +11 -3
  114. data/sig/imagekitio/models/accounts/origin_update_params.rbs +4 -9
  115. data/sig/imagekitio/models/accounts/url_endpoint_delete_params.rbs +11 -3
  116. data/sig/imagekitio/models/accounts/url_endpoint_get_params.rbs +11 -3
  117. data/sig/imagekitio/models/accounts/url_endpoint_update_params.rbs +13 -3
  118. data/sig/imagekitio/models/ai_tag.rbs +27 -0
  119. data/sig/imagekitio/models/beta/v2/file_upload_response.rbs +30 -223
  120. data/sig/imagekitio/models/cache/invalidation_get_params.rbs +11 -3
  121. data/sig/imagekitio/models/custom_metadata.rbs +7 -0
  122. data/sig/imagekitio/models/custom_metadata_field_delete_params.rbs +11 -3
  123. data/sig/imagekitio/models/custom_metadata_field_update_params.rbs +5 -0
  124. data/sig/imagekitio/models/embedded_metadata.rbs +7 -0
  125. data/sig/imagekitio/models/file.rbs +29 -224
  126. data/sig/imagekitio/models/file_create_event.rbs +32 -0
  127. data/sig/imagekitio/models/file_delete_event.rbs +48 -0
  128. data/sig/imagekitio/models/file_delete_params.rbs +11 -3
  129. data/sig/imagekitio/models/file_get_params.rbs +12 -3
  130. data/sig/imagekitio/models/file_update_event.rbs +32 -0
  131. data/sig/imagekitio/models/file_update_params.rbs +4 -9
  132. data/sig/imagekitio/models/file_upload_response.rbs +29 -224
  133. data/sig/imagekitio/models/file_version_create_event.rbs +36 -0
  134. data/sig/imagekitio/models/file_version_delete_event.rbs +50 -0
  135. data/sig/imagekitio/models/files/metadata_get_params.rbs +11 -3
  136. data/sig/imagekitio/models/files/version_delete_params.rbs +6 -1
  137. data/sig/imagekitio/models/files/version_get_params.rbs +6 -1
  138. data/sig/imagekitio/models/files/version_list_params.rbs +11 -3
  139. data/sig/imagekitio/models/files/version_restore_params.rbs +6 -1
  140. data/sig/imagekitio/models/folders/job_get_params.rbs +11 -3
  141. data/sig/imagekitio/models/overlay_position.rbs +73 -3
  142. data/sig/imagekitio/models/saved_extension_delete_params.rbs +11 -3
  143. data/sig/imagekitio/models/saved_extension_get_params.rbs +11 -3
  144. data/sig/imagekitio/models/saved_extension_update_params.rbs +5 -0
  145. data/sig/imagekitio/models/selected_fields_schema.rbs +165 -0
  146. data/sig/imagekitio/models/unsafe_unwrap_webhook_event.rbs +5 -0
  147. data/sig/imagekitio/models/unwrap_webhook_event.rbs +5 -0
  148. data/sig/imagekitio/models/upload_pre_transform_success_event.rbs +29 -224
  149. data/sig/imagekitio/models/version_info.rbs +19 -0
  150. data/sig/imagekitio/models.rbs +22 -0
  151. data/sig/imagekitio/resources/accounts/origins.rbs +2 -2
  152. data/sig/imagekitio/resources/files.rbs +1 -1
  153. data/sig/imagekitio/resources/webhooks.rbs +15 -3
  154. metadata +46 -2
@@ -14,6 +14,9 @@ module Imagekitio
14
14
  )
15
15
  end
16
16
 
17
+ sig { returns(String) }
18
+ attr_accessor :id
19
+
17
20
  # Human readable name of the custom metadata field. This should be unique across
18
21
  # all non deleted custom metadata fields. This name is displayed as form field
19
22
  # label to the users while setting field value on an asset in the media library
@@ -42,12 +45,14 @@ module Imagekitio
42
45
 
43
46
  sig do
44
47
  params(
48
+ id: String,
45
49
  label: String,
46
50
  schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema::OrHash,
47
51
  request_options: Imagekitio::RequestOptions::OrHash
48
52
  ).returns(T.attached_class)
49
53
  end
50
54
  def self.new(
55
+ id:,
51
56
  # Human readable name of the custom metadata field. This should be unique across
52
57
  # all non deleted custom metadata fields. This name is displayed as form field
53
58
  # label to the users while setting field value on an asset in the media library
@@ -65,6 +70,7 @@ module Imagekitio
65
70
  sig do
66
71
  override.returns(
67
72
  {
73
+ id: String,
68
74
  label: String,
69
75
  schema: Imagekitio::CustomMetadataFieldUpdateParams::Schema,
70
76
  request_options: Imagekitio::RequestOptions
@@ -0,0 +1,11 @@
1
+ # typed: strong
2
+
3
+ module Imagekitio
4
+ module Models
5
+ EmbeddedMetadata =
6
+ T.let(
7
+ Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown],
8
+ Imagekitio::Internal::Type::Converter
9
+ )
10
+ end
11
+ end
@@ -374,8 +374,10 @@ module Imagekitio
374
374
  sig { params(min_selections: Integer).void }
375
375
  attr_writer :min_selections
376
376
 
377
- # Array of possible tag values. Combined length of all strings must not exceed 500
378
- # characters. Cannot contain the `%` character.
377
+ # Array of possible tag values. The combined length of all strings must not exceed
378
+ # 500 characters, and values cannot include the `%` character. When providing
379
+ # large vocabularies (more than 30 items), the AI may not follow the list
380
+ # strictly.
379
381
  sig { returns(T.nilable(T::Array[String])) }
380
382
  attr_reader :vocabulary
381
383
 
@@ -398,8 +400,10 @@ module Imagekitio
398
400
  max_selections: nil,
399
401
  # Minimum number of tags to select from the vocabulary.
400
402
  min_selections: nil,
401
- # Array of possible tag values. Combined length of all strings must not exceed 500
402
- # characters. Cannot contain the `%` character.
403
+ # Array of possible tag values. The combined length of all strings must not exceed
404
+ # 500 characters, and values cannot include the `%` character. When providing
405
+ # large vocabularies (more than 30 items), the AI may not follow the list
406
+ # strictly.
403
407
  vocabulary: nil,
404
408
  # Task type that analyzes the image and adds matching tags from a vocabulary.
405
409
  type: :select_tags
@@ -457,7 +461,10 @@ module Imagekitio
457
461
  sig { params(min_selections: Integer).void }
458
462
  attr_writer :min_selections
459
463
 
460
- # Array of possible values matching the custom metadata field type.
464
+ # An array of possible values matching the custom metadata field type. If not
465
+ # provided for SingleSelect or MultiSelect field types, all values from the custom
466
+ # metadata field definition will be used. When providing large vocabularies (above
467
+ # 30 items), the AI may not strictly adhere to the list.
461
468
  sig do
462
469
  returns(
463
470
  T.nilable(
@@ -501,7 +508,10 @@ module Imagekitio
501
508
  max_selections: nil,
502
509
  # Minimum number of values to select from the vocabulary.
503
510
  min_selections: nil,
504
- # Array of possible values matching the custom metadata field type.
511
+ # An array of possible values matching the custom metadata field type. If not
512
+ # provided for SingleSelect or MultiSelect field types, all values from the custom
513
+ # metadata field definition will be used. When providing large vocabularies (above
514
+ # 30 items), the AI may not strictly adhere to the list.
505
515
  vocabulary: nil,
506
516
  # Task type that analyzes the image and sets a custom metadata field value from a
507
517
  # vocabulary.
@@ -371,8 +371,10 @@ module Imagekitio
371
371
  sig { params(min_selections: Integer).void }
372
372
  attr_writer :min_selections
373
373
 
374
- # Array of possible tag values. Combined length of all strings must not exceed 500
375
- # characters. Cannot contain the `%` character.
374
+ # Array of possible tag values. The combined length of all strings must not exceed
375
+ # 500 characters, and values cannot include the `%` character. When providing
376
+ # large vocabularies (more than 30 items), the AI may not follow the list
377
+ # strictly.
376
378
  sig { returns(T.nilable(T::Array[String])) }
377
379
  attr_reader :vocabulary
378
380
 
@@ -395,8 +397,10 @@ module Imagekitio
395
397
  max_selections: nil,
396
398
  # Minimum number of tags to select from the vocabulary.
397
399
  min_selections: nil,
398
- # Array of possible tag values. Combined length of all strings must not exceed 500
399
- # characters. Cannot contain the `%` character.
400
+ # Array of possible tag values. The combined length of all strings must not exceed
401
+ # 500 characters, and values cannot include the `%` character. When providing
402
+ # large vocabularies (more than 30 items), the AI may not follow the list
403
+ # strictly.
400
404
  vocabulary: nil,
401
405
  # Task type that analyzes the image and adds matching tags from a vocabulary.
402
406
  type: :select_tags
@@ -454,7 +458,10 @@ module Imagekitio
454
458
  sig { params(min_selections: Integer).void }
455
459
  attr_writer :min_selections
456
460
 
457
- # Array of possible values matching the custom metadata field type.
461
+ # An array of possible values matching the custom metadata field type. If not
462
+ # provided for SingleSelect or MultiSelect field types, all values from the custom
463
+ # metadata field definition will be used. When providing large vocabularies (above
464
+ # 30 items), the AI may not strictly adhere to the list.
458
465
  sig do
459
466
  returns(
460
467
  T.nilable(
@@ -498,7 +505,10 @@ module Imagekitio
498
505
  max_selections: nil,
499
506
  # Minimum number of values to select from the vocabulary.
500
507
  min_selections: nil,
501
- # Array of possible values matching the custom metadata field type.
508
+ # An array of possible values matching the custom metadata field type. If not
509
+ # provided for SingleSelect or MultiSelect field types, all values from the custom
510
+ # metadata field definition will be used. When providing large vocabularies (above
511
+ # 30 items), the AI may not strictly adhere to the list.
502
512
  vocabulary: nil,
503
513
  # Task type that analyzes the image and sets a custom metadata field value from a
504
514
  # vocabulary.