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
@@ -15,62 +15,28 @@ module Imagekitio
15
15
  )
16
16
  end
17
17
 
18
- # Schema for origin request resources.
19
- sig do
20
- returns(
21
- T.any(
22
- Imagekitio::Accounts::OriginRequest::S3,
23
- Imagekitio::Accounts::OriginRequest::S3Compatible,
24
- Imagekitio::Accounts::OriginRequest::CloudinaryBackup,
25
- Imagekitio::Accounts::OriginRequest::WebFolder,
26
- Imagekitio::Accounts::OriginRequest::WebProxy,
27
- Imagekitio::Accounts::OriginRequest::Gcs,
28
- Imagekitio::Accounts::OriginRequest::AzureBlob,
29
- Imagekitio::Accounts::OriginRequest::AkeneoPim
30
- )
31
- )
32
- end
33
- attr_accessor :origin_request
18
+ # Unique identifier for the origin. This is generated by ImageKit when you create
19
+ # a new origin.
20
+ sig { returns(String) }
21
+ attr_accessor :id
34
22
 
35
23
  sig do
36
24
  params(
37
- origin_request:
38
- T.any(
39
- Imagekitio::Accounts::OriginRequest::S3::OrHash,
40
- Imagekitio::Accounts::OriginRequest::S3Compatible::OrHash,
41
- Imagekitio::Accounts::OriginRequest::CloudinaryBackup::OrHash,
42
- Imagekitio::Accounts::OriginRequest::WebFolder::OrHash,
43
- Imagekitio::Accounts::OriginRequest::WebProxy::OrHash,
44
- Imagekitio::Accounts::OriginRequest::Gcs::OrHash,
45
- Imagekitio::Accounts::OriginRequest::AzureBlob::OrHash,
46
- Imagekitio::Accounts::OriginRequest::AkeneoPim::OrHash
47
- ),
25
+ id: String,
48
26
  request_options: Imagekitio::RequestOptions::OrHash
49
27
  ).returns(T.attached_class)
50
28
  end
51
29
  def self.new(
52
- # Schema for origin request resources.
53
- origin_request:,
30
+ # Unique identifier for the origin. This is generated by ImageKit when you create
31
+ # a new origin.
32
+ id:,
54
33
  request_options: {}
55
34
  )
56
35
  end
57
36
 
58
37
  sig do
59
38
  override.returns(
60
- {
61
- origin_request:
62
- T.any(
63
- Imagekitio::Accounts::OriginRequest::S3,
64
- Imagekitio::Accounts::OriginRequest::S3Compatible,
65
- Imagekitio::Accounts::OriginRequest::CloudinaryBackup,
66
- Imagekitio::Accounts::OriginRequest::WebFolder,
67
- Imagekitio::Accounts::OriginRequest::WebProxy,
68
- Imagekitio::Accounts::OriginRequest::Gcs,
69
- Imagekitio::Accounts::OriginRequest::AzureBlob,
70
- Imagekitio::Accounts::OriginRequest::AkeneoPim
71
- ),
72
- request_options: Imagekitio::RequestOptions
73
- }
39
+ { id: String, request_options: Imagekitio::RequestOptions }
74
40
  )
75
41
  end
76
42
  def to_hash
@@ -15,16 +15,31 @@ module Imagekitio
15
15
  )
16
16
  end
17
17
 
18
+ # Unique identifier for the URL-endpoint. This is generated by ImageKit when you
19
+ # create a new URL-endpoint. For the default URL-endpoint, this is always
20
+ # `default`.
21
+ sig { returns(String) }
22
+ attr_accessor :id
23
+
18
24
  sig do
19
- params(request_options: Imagekitio::RequestOptions::OrHash).returns(
20
- T.attached_class
21
- )
25
+ params(
26
+ id: String,
27
+ request_options: Imagekitio::RequestOptions::OrHash
28
+ ).returns(T.attached_class)
22
29
  end
23
- def self.new(request_options: {})
30
+ def self.new(
31
+ # Unique identifier for the URL-endpoint. This is generated by ImageKit when you
32
+ # create a new URL-endpoint. For the default URL-endpoint, this is always
33
+ # `default`.
34
+ id:,
35
+ request_options: {}
36
+ )
24
37
  end
25
38
 
26
39
  sig do
27
- override.returns({ request_options: Imagekitio::RequestOptions })
40
+ override.returns(
41
+ { id: String, request_options: Imagekitio::RequestOptions }
42
+ )
28
43
  end
29
44
  def to_hash
30
45
  end
@@ -15,16 +15,31 @@ module Imagekitio
15
15
  )
16
16
  end
17
17
 
18
+ # Unique identifier for the URL-endpoint. This is generated by ImageKit when you
19
+ # create a new URL-endpoint. For the default URL-endpoint, this is always
20
+ # `default`.
21
+ sig { returns(String) }
22
+ attr_accessor :id
23
+
18
24
  sig do
19
- params(request_options: Imagekitio::RequestOptions::OrHash).returns(
20
- T.attached_class
21
- )
25
+ params(
26
+ id: String,
27
+ request_options: Imagekitio::RequestOptions::OrHash
28
+ ).returns(T.attached_class)
22
29
  end
23
- def self.new(request_options: {})
30
+ def self.new(
31
+ # Unique identifier for the URL-endpoint. This is generated by ImageKit when you
32
+ # create a new URL-endpoint. For the default URL-endpoint, this is always
33
+ # `default`.
34
+ id:,
35
+ request_options: {}
36
+ )
24
37
  end
25
38
 
26
39
  sig do
27
- override.returns({ request_options: Imagekitio::RequestOptions })
40
+ override.returns(
41
+ { id: String, request_options: Imagekitio::RequestOptions }
42
+ )
28
43
  end
29
44
  def to_hash
30
45
  end
@@ -15,16 +15,31 @@ module Imagekitio
15
15
  )
16
16
  end
17
17
 
18
+ # Unique identifier for the URL-endpoint. This is generated by ImageKit when you
19
+ # create a new URL-endpoint. For the default URL-endpoint, this is always
20
+ # `default`.
21
+ sig { returns(String) }
22
+ attr_accessor :id
23
+
18
24
  sig do
19
- params(request_options: Imagekitio::RequestOptions::OrHash).returns(
20
- T.attached_class
21
- )
25
+ params(
26
+ id: String,
27
+ request_options: Imagekitio::RequestOptions::OrHash
28
+ ).returns(T.attached_class)
22
29
  end
23
- def self.new(request_options: {})
30
+ def self.new(
31
+ # Unique identifier for the URL-endpoint. This is generated by ImageKit when you
32
+ # create a new URL-endpoint. For the default URL-endpoint, this is always
33
+ # `default`.
34
+ id:,
35
+ request_options: {}
36
+ )
24
37
  end
25
38
 
26
39
  sig do
27
- override.returns({ request_options: Imagekitio::RequestOptions })
40
+ override.returns(
41
+ { id: String, request_options: Imagekitio::RequestOptions }
42
+ )
28
43
  end
29
44
  def to_hash
30
45
  end
@@ -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