imagekitio 4.10.0 → 4.12.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 (134) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +37 -0
  3. data/README.md +28 -1
  4. data/lib/imagekitio/client.rb +4 -0
  5. data/lib/imagekitio/internal/tag_cursor.rb +86 -0
  6. data/lib/imagekitio/models/accounts/contract_get_params.rb +16 -0
  7. data/lib/imagekitio/models/accounts/contract_get_response.rb +82 -0
  8. data/lib/imagekitio/models/accounts/contract_units.rb +42 -0
  9. data/lib/imagekitio/models/accounts/url_endpoint_request.rb +17 -1
  10. data/lib/imagekitio/models/accounts/url_endpoint_response.rb +17 -1
  11. data/lib/imagekitio/models/accounts/webhook.rb +81 -0
  12. data/lib/imagekitio/models/accounts/webhook_create_params.rb +47 -0
  13. data/lib/imagekitio/models/accounts/webhook_delete_params.rb +24 -0
  14. data/lib/imagekitio/models/accounts/webhook_event_type.rb +32 -0
  15. data/lib/imagekitio/models/accounts/webhook_get_params.rb +24 -0
  16. data/lib/imagekitio/models/accounts/webhook_list_params.rb +16 -0
  17. data/lib/imagekitio/models/accounts/webhook_list_response.rb +10 -0
  18. data/lib/imagekitio/models/accounts/webhook_update_params.rb +54 -0
  19. data/lib/imagekitio/models/asset_list_params.rb +18 -0
  20. data/lib/imagekitio/models/beta/v2/file_upload_params.rb +5 -1
  21. data/lib/imagekitio/models/custom_metadata_field.rb +16 -3
  22. data/lib/imagekitio/models/custom_metadata_field_create_params.rb +4 -0
  23. data/lib/imagekitio/models/file_upload_params.rb +5 -1
  24. data/lib/imagekitio/models/folder.rb +33 -1
  25. data/lib/imagekitio/models/folder_create_event.rb +35 -0
  26. data/lib/imagekitio/models/folder_delete_event.rb +47 -0
  27. data/lib/imagekitio/models/folder_update_event.rb +35 -0
  28. data/lib/imagekitio/models/tag.rb +52 -0
  29. data/lib/imagekitio/models/tag_list_params.rb +143 -0
  30. data/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb +10 -1
  31. data/lib/imagekitio/models/unwrap_webhook_event.rb +10 -1
  32. data/lib/imagekitio/models/update_file_request.rb +5 -0
  33. data/lib/imagekitio/models.rb +10 -0
  34. data/lib/imagekitio/resources/accounts/contract.rb +47 -0
  35. data/lib/imagekitio/resources/accounts/webhooks.rb +146 -0
  36. data/lib/imagekitio/resources/accounts.rb +8 -0
  37. data/lib/imagekitio/resources/custom_metadata_fields.rb +2 -2
  38. data/lib/imagekitio/resources/files/versions.rb +2 -2
  39. data/lib/imagekitio/resources/files.rb +4 -16
  40. data/lib/imagekitio/resources/folders.rb +2 -8
  41. data/lib/imagekitio/resources/tags.rb +65 -0
  42. data/lib/imagekitio/resources/webhooks.rb +2 -2
  43. data/lib/imagekitio/version.rb +1 -1
  44. data/lib/imagekitio.rb +20 -5
  45. data/rbi/imagekitio/client.rbi +3 -0
  46. data/rbi/imagekitio/internal/tag_cursor.rbi +22 -0
  47. data/rbi/imagekitio/models/accounts/contract_get_params.rbi +34 -0
  48. data/rbi/imagekitio/models/accounts/contract_get_response.rbi +126 -0
  49. data/rbi/imagekitio/models/accounts/contract_units.rbi +66 -0
  50. data/rbi/imagekitio/models/accounts/url_endpoint_request.rbi +19 -1
  51. data/rbi/imagekitio/models/accounts/url_endpoint_response.rbi +19 -1
  52. data/rbi/imagekitio/models/accounts/webhook.rbi +109 -0
  53. data/rbi/imagekitio/models/accounts/webhook_create_params.rbi +78 -0
  54. data/rbi/imagekitio/models/accounts/webhook_delete_params.rbi +45 -0
  55. data/rbi/imagekitio/models/accounts/webhook_event_type.rbi +101 -0
  56. data/rbi/imagekitio/models/accounts/webhook_get_params.rbi +45 -0
  57. data/rbi/imagekitio/models/accounts/webhook_list_params.rbi +34 -0
  58. data/rbi/imagekitio/models/accounts/webhook_list_response.rbi +13 -0
  59. data/rbi/imagekitio/models/accounts/webhook_update_params.rbi +98 -0
  60. data/rbi/imagekitio/models/asset_list_params.rbi +27 -0
  61. data/rbi/imagekitio/models/beta/v2/file_upload_params.rbi +10 -2
  62. data/rbi/imagekitio/models/custom_metadata_field.rbi +30 -4
  63. data/rbi/imagekitio/models/custom_metadata_field_create_params.rbi +8 -0
  64. data/rbi/imagekitio/models/file_upload_params.rbi +10 -2
  65. data/rbi/imagekitio/models/folder.rbi +49 -0
  66. data/rbi/imagekitio/models/folder_create_event.rbi +53 -0
  67. data/rbi/imagekitio/models/folder_delete_event.rbi +83 -0
  68. data/rbi/imagekitio/models/folder_update_event.rbi +53 -0
  69. data/rbi/imagekitio/models/tag.rbi +71 -0
  70. data/rbi/imagekitio/models/tag_list_params.rbi +236 -0
  71. data/rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi +4 -1
  72. data/rbi/imagekitio/models/unwrap_webhook_event.rbi +4 -1
  73. data/rbi/imagekitio/models/update_file_request.rbi +10 -0
  74. data/rbi/imagekitio/models.rbi +10 -0
  75. data/rbi/imagekitio/resources/accounts/contract.rbi +36 -0
  76. data/rbi/imagekitio/resources/accounts/webhooks.rbi +113 -0
  77. data/rbi/imagekitio/resources/accounts.rbi +6 -0
  78. data/rbi/imagekitio/resources/assets.rbi +9 -0
  79. data/rbi/imagekitio/resources/beta/v2/files.rbi +5 -1
  80. data/rbi/imagekitio/resources/custom_metadata_fields.rbi +5 -1
  81. data/rbi/imagekitio/resources/files/versions.rbi +1 -1
  82. data/rbi/imagekitio/resources/files.rbi +7 -3
  83. data/rbi/imagekitio/resources/folders.rbi +1 -1
  84. data/rbi/imagekitio/resources/tags.rbi +74 -0
  85. data/rbi/imagekitio/resources/webhooks.rbi +8 -2
  86. data/sig/imagekitio/client.rbs +2 -0
  87. data/sig/imagekitio/internal/tag_cursor.rbs +13 -0
  88. data/sig/imagekitio/models/accounts/contract_get_params.rbs +17 -0
  89. data/sig/imagekitio/models/accounts/contract_get_response.rbs +73 -0
  90. data/sig/imagekitio/models/accounts/contract_units.rbs +37 -0
  91. data/sig/imagekitio/models/accounts/url_endpoint_request.rbs +12 -2
  92. data/sig/imagekitio/models/accounts/url_endpoint_response.rbs +12 -2
  93. data/sig/imagekitio/models/accounts/webhook.rbs +52 -0
  94. data/sig/imagekitio/models/accounts/webhook_create_params.rbs +40 -0
  95. data/sig/imagekitio/models/accounts/webhook_delete_params.rbs +25 -0
  96. data/sig/imagekitio/models/accounts/webhook_event_type.rbs +44 -0
  97. data/sig/imagekitio/models/accounts/webhook_get_params.rbs +25 -0
  98. data/sig/imagekitio/models/accounts/webhook_list_params.rbs +17 -0
  99. data/sig/imagekitio/models/accounts/webhook_list_response.rbs +9 -0
  100. data/sig/imagekitio/models/accounts/webhook_update_params.rbs +51 -0
  101. data/sig/imagekitio/models/folder.rbs +32 -5
  102. data/sig/imagekitio/models/folder_create_event.rbs +32 -0
  103. data/sig/imagekitio/models/folder_delete_event.rbs +48 -0
  104. data/sig/imagekitio/models/folder_update_event.rbs +32 -0
  105. data/sig/imagekitio/models/tag.rbs +30 -0
  106. data/sig/imagekitio/models/tag_list_params.rbs +114 -0
  107. data/sig/imagekitio/models/unsafe_unwrap_webhook_event.rbs +3 -0
  108. data/sig/imagekitio/models/unwrap_webhook_event.rbs +3 -0
  109. data/sig/imagekitio/models.rbs +10 -0
  110. data/sig/imagekitio/resources/accounts/contract.rbs +13 -0
  111. data/sig/imagekitio/resources/accounts/webhooks.rbs +38 -0
  112. data/sig/imagekitio/resources/accounts.rbs +4 -0
  113. data/sig/imagekitio/resources/custom_metadata_fields.rbs +1 -4
  114. data/sig/imagekitio/resources/files/versions.rbs +1 -1
  115. data/sig/imagekitio/resources/files.rbs +2 -2
  116. data/sig/imagekitio/resources/folders.rbs +1 -1
  117. data/sig/imagekitio/resources/tags.rbs +18 -0
  118. data/sig/imagekitio/resources/webhooks.rbs +8 -2
  119. metadata +62 -17
  120. data/lib/imagekitio/models/custom_metadata_field_delete_response.rb +0 -10
  121. data/lib/imagekitio/models/file_copy_response.rb +0 -10
  122. data/lib/imagekitio/models/file_move_response.rb +0 -10
  123. data/lib/imagekitio/models/files/version_delete_response.rb +0 -12
  124. data/lib/imagekitio/models/folder_delete_response.rb +0 -10
  125. data/rbi/imagekitio/models/custom_metadata_field_delete_response.rbi +0 -23
  126. data/rbi/imagekitio/models/file_copy_response.rbi +0 -23
  127. data/rbi/imagekitio/models/file_move_response.rbi +0 -23
  128. data/rbi/imagekitio/models/files/version_delete_response.rbi +0 -25
  129. data/rbi/imagekitio/models/folder_delete_response.rbi +0 -23
  130. data/sig/imagekitio/models/custom_metadata_field_delete_response.rbs +0 -11
  131. data/sig/imagekitio/models/file_copy_response.rbs +0 -11
  132. data/sig/imagekitio/models/file_move_response.rbs +0 -11
  133. data/sig/imagekitio/models/files/version_delete_response.rbs +0 -13
  134. data/sig/imagekitio/models/folder_delete_response.rbs +0 -11
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Imagekitio
4
+ module Models
5
+ module Accounts
6
+ # @see Imagekitio::Resources::Accounts::Webhooks#update
7
+ class WebhookUpdateParams < Imagekitio::Internal::Type::BaseModel
8
+ extend Imagekitio::Internal::Type::RequestParameters::Converter
9
+ include Imagekitio::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ # Unique identifier for a webhook.
13
+ #
14
+ # @return [String]
15
+ required :id, String
16
+
17
+ # @!attribute enabled
18
+ # Whether the webhook is enabled. Omit to leave the current value unchanged.
19
+ #
20
+ # @return [Boolean, nil]
21
+ optional :enabled, Imagekitio::Internal::Type::Boolean
22
+
23
+ # @!attribute endpoint
24
+ # The URL where ImageKit sends webhook events as `POST` requests. Must use the
25
+ # `http` or `https` protocol, and must be unique across all webhooks for your
26
+ # account.
27
+ #
28
+ # @return [String, nil]
29
+ optional :endpoint, String
30
+
31
+ # @!attribute events
32
+ # The event types this webhook is subscribed to. Replaces the existing list. Omit
33
+ # to leave the current value unchanged.
34
+ #
35
+ # @return [Array<Symbol, Imagekitio::Models::Accounts::WebhookEventType>, nil]
36
+ optional :events, -> { Imagekitio::Internal::Type::ArrayOf[enum: Imagekitio::Accounts::WebhookEventType] }
37
+
38
+ # @!method initialize(id:, enabled: nil, endpoint: nil, events: nil, request_options: {})
39
+ # Some parameter documentations has been truncated, see
40
+ # {Imagekitio::Models::Accounts::WebhookUpdateParams} for more details.
41
+ #
42
+ # @param id [String] Unique identifier for a webhook.
43
+ #
44
+ # @param enabled [Boolean] Whether the webhook is enabled. Omit to leave the current value unchanged.
45
+ #
46
+ # @param endpoint [String] The URL where ImageKit sends webhook events as `POST` requests. Must use the `ht
47
+ #
48
+ # @param events [Array<Symbol, Imagekitio::Models::Accounts::WebhookEventType>] The event types this webhook is subscribed to. Replaces the existing list. Omit
49
+ #
50
+ # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
51
+ end
52
+ end
53
+ end
54
+ end
@@ -62,6 +62,15 @@ module Imagekitio
62
62
  # Sort the results by one of the supported fields in ascending or descending
63
63
  # order.
64
64
  #
65
+ # `ASC_ORIGINAL_CREATION_DATE` and `DESC_ORIGINAL_CREATION_DATE` sort files by the
66
+ # value of the reserved `_internal_original_created_datetime` custom metadata
67
+ # field (labelled "Original creation date" in the dashboard). This field exists
68
+ # only after you enable the original creation date setting under the Custom
69
+ # Metadata tab of the media library settings. Files that have no value set for
70
+ # this field fall back to their upload time, so migrated assets carrying a
71
+ # preserved original date and natively uploaded assets are ordered together in a
72
+ # single timeline.
73
+ #
65
74
  # @return [Symbol, Imagekitio::Models::AssetListParams::Sort, nil]
66
75
  optional :sort, enum: -> { Imagekitio::AssetListParams::Sort }
67
76
 
@@ -114,6 +123,15 @@ module Imagekitio
114
123
 
115
124
  # Sort the results by one of the supported fields in ascending or descending
116
125
  # order.
126
+ #
127
+ # `ASC_ORIGINAL_CREATION_DATE` and `DESC_ORIGINAL_CREATION_DATE` sort files by the
128
+ # value of the reserved `_internal_original_created_datetime` custom metadata
129
+ # field (labelled "Original creation date" in the dashboard). This field exists
130
+ # only after you enable the original creation date setting under the Custom
131
+ # Metadata tab of the media library settings. Files that have no value set for
132
+ # this field fall back to their upload time, so migrated assets carrying a
133
+ # preserved original date and natively uploaded assets are ordered together in a
134
+ # single timeline.
117
135
  module Sort
118
136
  extend Imagekitio::Internal::Type::Enum
119
137
 
@@ -132,7 +132,11 @@ module Imagekitio
132
132
 
133
133
  # @!attribute custom_metadata
134
134
  # JSON key-value pairs to associate with the asset. Create the custom metadata
135
- # fields before setting these values.
135
+ # fields before setting these values. To preserve the original creation date of an
136
+ # asset migrated from another system, set the reserved
137
+ # `_internal_original_created_datetime` key to an ISO 8601 date string. This key
138
+ # is available once the original creation date setting is enabled in the media
139
+ # library settings.
136
140
  #
137
141
  # @return [Hash{Symbol=>Object}, nil]
138
142
  optional :custom_metadata,
@@ -40,8 +40,21 @@ module Imagekitio
40
40
  optional :description, String
41
41
 
42
42
  # @!attribute reserved
43
- # Present and set to `true` when the field is reserved. Omitted for regular
44
- # fields. Reserved fields cannot be deleted.
43
+ # Present and set to `true` when the field is reserved, i.e. created and managed
44
+ # by ImageKit rather than by you. Omitted for regular fields.
45
+ #
46
+ # Currently the only reserved field is `_internal_original_created_datetime`
47
+ # (label "Original creation date", type `Date`). ImageKit creates it when you
48
+ # enable the original creation date setting under the Custom Metadata tab of the
49
+ # media library settings in the dashboard. Use it to preserve the original
50
+ # creation date of assets migrated from another system: set its value through the
51
+ # `customMetadata` object in the upload or update file details API, then sort with
52
+ # `ASC_ORIGINAL_CREATION_DATE` or `DESC_ORIGINAL_CREATION_DATE` in the list and
53
+ # search assets API, or filter with
54
+ # `"customMetadata._internal_original_created_datetime"` in `searchQuery`.
55
+ #
56
+ # Reserved fields cannot be deleted, and their name cannot be reused when creating
57
+ # a new field.
45
58
  #
46
59
  # @return [Boolean, nil]
47
60
  optional :reserved, Imagekitio::Internal::Type::Boolean
@@ -62,7 +75,7 @@ module Imagekitio
62
75
  #
63
76
  # @param description [String] Optional description of the custom metadata field. Only present when a descripti
64
77
  #
65
- # @param reserved [Boolean] Present and set to `true` when the field is reserved. Omitted for regular fields
78
+ # @param reserved [Boolean] Present and set to `true` when the field is reserved, i.e. created and managed b
66
79
 
67
80
  # @see Imagekitio::Models::CustomMetadataField#schema
68
81
  class Schema < Imagekitio::Internal::Type::BaseModel
@@ -20,6 +20,10 @@ module Imagekitio
20
20
  # API name of the custom metadata field. This should be unique across all
21
21
  # (including deleted) custom metadata fields.
22
22
  #
23
+ # `_internal_original_created_datetime` is a reserved name and cannot be used.
24
+ # ImageKit creates that field automatically when you enable the original creation
25
+ # date setting in the media library settings.
26
+ #
23
27
  # @return [String]
24
28
  required :name, String
25
29
 
@@ -130,7 +130,11 @@ module Imagekitio
130
130
 
131
131
  # @!attribute custom_metadata
132
132
  # JSON key-value pairs to associate with the asset. Create the custom metadata
133
- # fields before setting these values.
133
+ # fields before setting these values. To preserve the original creation date of an
134
+ # asset migrated from another system, set the reserved
135
+ # `_internal_original_created_datetime` key to an ISO 8601 date string. This key
136
+ # is available once the original creation date setting is enabled in the media
137
+ # library settings.
134
138
  #
135
139
  # @return [Hash{Symbol=>Object}, nil]
136
140
  optional :custom_metadata,
@@ -10,6 +10,13 @@ module Imagekitio
10
10
  # @return [Time, nil]
11
11
  optional :created_at, Time, api_name: :createdAt
12
12
 
13
+ # @!attribute created_by
14
+ # Details of the user who created the folder. Present only when this information
15
+ # is available. The `name` is the name of the user at the time of folder creation.
16
+ #
17
+ # @return [Imagekitio::Models::Folder::CreatedBy, nil]
18
+ optional :created_by, -> { Imagekitio::Folder::CreatedBy }, api_name: :createdBy
19
+
13
20
  # @!attribute custom_metadata
14
21
  # An object with custom metadata for the folder. Returns empty object if no custom
15
22
  # metadata is set.
@@ -53,12 +60,14 @@ module Imagekitio
53
60
  # @return [Time, nil]
54
61
  optional :updated_at, Time, api_name: :updatedAt
55
62
 
56
- # @!method initialize(created_at: nil, custom_metadata: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil)
63
+ # @!method initialize(created_at: nil, created_by: nil, custom_metadata: nil, folder_id: nil, folder_path: nil, name: nil, type: nil, updated_at: nil)
57
64
  # Some parameter documentations has been truncated, see
58
65
  # {Imagekitio::Models::Folder} for more details.
59
66
  #
60
67
  # @param created_at [Time] Date and time when the folder was created. The date and time is in ISO8601 forma
61
68
  #
69
+ # @param created_by [Imagekitio::Models::Folder::CreatedBy] Details of the user who created the folder. Present only when this information i
70
+ #
62
71
  # @param custom_metadata [Hash{Symbol=>Object}] An object with custom metadata for the folder. Returns empty object if no custom
63
72
  #
64
73
  # @param folder_id [String] Unique identifier of the asset.
@@ -71,6 +80,29 @@ module Imagekitio
71
80
  #
72
81
  # @param updated_at [Time] Date and time when the folder was last updated. The date and time is in ISO8601
73
82
 
83
+ # @see Imagekitio::Models::Folder#created_by
84
+ class CreatedBy < Imagekitio::Internal::Type::BaseModel
85
+ # @!attribute email
86
+ # Email of the user who created the folder.
87
+ #
88
+ # @return [String, nil]
89
+ optional :email, String
90
+
91
+ # @!attribute name
92
+ # Name of the user who created the folder.
93
+ #
94
+ # @return [String, nil]
95
+ optional :name, String
96
+
97
+ # @!method initialize(email: nil, name: nil)
98
+ # Details of the user who created the folder. Present only when this information
99
+ # is available. The `name` is the name of the user at the time of folder creation.
100
+ #
101
+ # @param email [String] Email of the user who created the folder.
102
+ #
103
+ # @param name [String] Name of the user who created the folder.
104
+ end
105
+
74
106
  # Type of the asset.
75
107
  #
76
108
  # @see Imagekitio::Models::Folder#type
@@ -0,0 +1,35 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Imagekitio
4
+ module Models
5
+ class FolderCreateEvent < Imagekitio::Models::BaseWebhookEvent
6
+ # @!attribute created_at
7
+ # Timestamp of when the event occurred in ISO8601 format.
8
+ #
9
+ # @return [Time]
10
+ required :created_at, Time
11
+
12
+ # @!attribute data
13
+ #
14
+ # @return [Imagekitio::Models::Folder]
15
+ required :data, -> { Imagekitio::Folder }
16
+
17
+ # @!attribute type
18
+ # Type of the webhook event.
19
+ #
20
+ # @return [Symbol, :"folder.created"]
21
+ required :type, const: :"folder.created"
22
+
23
+ # @!method initialize(created_at:, data:, type: :"folder.created")
24
+ # Triggered when a folder is created, whether explicitly, by copying or moving a
25
+ # folder, or implicitly when an upload creates missing parent folders. Copying or
26
+ # moving a folder tree sends one event per folder in the tree.
27
+ #
28
+ # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
29
+ #
30
+ # @param data [Imagekitio::Models::Folder]
31
+ #
32
+ # @param type [Symbol, :"folder.created"] Type of the webhook event.
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Imagekitio
4
+ module Models
5
+ class FolderDeleteEvent < Imagekitio::Models::BaseWebhookEvent
6
+ # @!attribute created_at
7
+ # Timestamp of when the event occurred in ISO8601 format.
8
+ #
9
+ # @return [Time]
10
+ required :created_at, Time
11
+
12
+ # @!attribute data
13
+ #
14
+ # @return [Imagekitio::Models::FolderDeleteEvent::Data]
15
+ required :data, -> { Imagekitio::FolderDeleteEvent::Data }
16
+
17
+ # @!attribute type
18
+ # Type of the webhook event.
19
+ #
20
+ # @return [Symbol, :"folder.deleted"]
21
+ required :type, const: :"folder.deleted"
22
+
23
+ # @!method initialize(created_at:, data:, type: :"folder.deleted")
24
+ # Triggered when a folder is deleted. Deleting a folder tree sends one event per
25
+ # folder in the tree; the files inside it send `file.deleted` events and their
26
+ # versions send `file-version.deleted` events. Moving a folder sends this event
27
+ # for the old `folderId` and `folder.created` for the new one.
28
+ #
29
+ # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
30
+ #
31
+ # @param data [Imagekitio::Models::FolderDeleteEvent::Data]
32
+ #
33
+ # @param type [Symbol, :"folder.deleted"] Type of the webhook event.
34
+
35
+ class Data < Imagekitio::Internal::Type::BaseModel
36
+ # @!attribute folder_id
37
+ # The unique `folderId` of the deleted folder.
38
+ #
39
+ # @return [String]
40
+ required :folder_id, String, api_name: :folderId
41
+
42
+ # @!method initialize(folder_id:)
43
+ # @param folder_id [String] The unique `folderId` of the deleted folder.
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,35 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Imagekitio
4
+ module Models
5
+ class FolderUpdateEvent < Imagekitio::Models::BaseWebhookEvent
6
+ # @!attribute created_at
7
+ # Timestamp of when the event occurred in ISO8601 format.
8
+ #
9
+ # @return [Time]
10
+ required :created_at, Time
11
+
12
+ # @!attribute data
13
+ #
14
+ # @return [Imagekitio::Models::Folder]
15
+ required :data, -> { Imagekitio::Folder }
16
+
17
+ # @!attribute type
18
+ # Type of the webhook event.
19
+ #
20
+ # @return [Symbol, :"folder.updated"]
21
+ required :type, const: :"folder.updated"
22
+
23
+ # @!method initialize(created_at:, data:, type: :"folder.updated")
24
+ # Triggered when a folder is updated, for example when its custom metadata changes
25
+ # or it is renamed. Renaming a folder sends one event per folder in the tree, each
26
+ # with its new `folderPath`.
27
+ #
28
+ # @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
29
+ #
30
+ # @param data [Imagekitio::Models::Folder]
31
+ #
32
+ # @param type [Symbol, :"folder.updated"] Type of the webhook event.
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Imagekitio
4
+ module Models
5
+ # @see Imagekitio::Resources::Tags#list
6
+ class Tag < Imagekitio::Internal::Type::BaseModel
7
+ # @!attribute asset_count
8
+ # The number of assets carrying the tag, counted across both tag sources
9
+ # (user-generated tags and AI-generated tags) and all file types regardless of the
10
+ # request's filters.
11
+ #
12
+ # @return [Integer]
13
+ required :asset_count, Integer, api_name: :assetCount
14
+
15
+ # @!attribute label
16
+ # The tag as it was spelled when it was last applied to any asset. Use it for
17
+ # display.
18
+ #
19
+ # @return [String]
20
+ required :label, String
21
+
22
+ # @!attribute last_used_at
23
+ # When the tag was last applied to an asset matching the `tagSource` and
24
+ # `fileType` filters of the request, in ISO 8601 format.
25
+ #
26
+ # @return [Time]
27
+ required :last_used_at, Time, api_name: :lastUsedAt
28
+
29
+ # @!attribute name
30
+ # The tag in lowercase. Tags are case-insensitive, so this is the unique key of
31
+ # the tag within your account.
32
+ #
33
+ # @return [String]
34
+ required :name, String
35
+
36
+ # @!method initialize(asset_count:, label:, last_used_at:, name:)
37
+ # Some parameter documentations has been truncated, see {Imagekitio::Models::Tag}
38
+ # for more details.
39
+ #
40
+ # A tag in use in your media library, aggregated case-insensitively across the
41
+ # assets that carry it.
42
+ #
43
+ # @param asset_count [Integer] The number of assets carrying the tag, counted across both tag sources (user-gen
44
+ #
45
+ # @param label [String] The tag as it was spelled when it was last applied to any asset. Use it for disp
46
+ #
47
+ # @param last_used_at [Time] When the tag was last applied to an asset matching the `tagSource` and `fileType
48
+ #
49
+ # @param name [String] The tag in lowercase. Tags are case-insensitive, so this is the unique key of th
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,143 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Imagekitio
4
+ module Models
5
+ # @see Imagekitio::Resources::Tags#list
6
+ class TagListParams < Imagekitio::Internal::Type::BaseModel
7
+ extend Imagekitio::Internal::Type::RequestParameters::Converter
8
+ include Imagekitio::Internal::Type::RequestParameters
9
+
10
+ # @!attribute cursor
11
+ # The `nextCursor` value from the previous response, to fetch the next page. A
12
+ # cursor is bound to the `tagSource`, `fileType`, `sort`, `search` and `prefix` it
13
+ # was issued with; sending it with different values returns a 400.
14
+ #
15
+ # @return [String, nil]
16
+ optional :cursor, String
17
+
18
+ # @!attribute file_type
19
+ # Filter tags by the type of asset they are applied to.
20
+ #
21
+ # - `image` — tags in use on images
22
+ # - `video` — tags in use on videos
23
+ # - `static` — tags in use on any other file, such as documents, scripts and
24
+ # stylesheets
25
+ # - `all` — tags in use on any asset
26
+ #
27
+ # @return [Symbol, Imagekitio::Models::TagListParams::FileType, nil]
28
+ optional :file_type, enum: -> { Imagekitio::TagListParams::FileType }
29
+
30
+ # @!attribute limit
31
+ # The maximum number of tags to return in response.
32
+ #
33
+ # @return [Integer, nil]
34
+ optional :limit, Integer
35
+
36
+ # @!attribute prefix
37
+ # Only return tags that begin with this value. Matching is case-insensitive.
38
+ #
39
+ # @return [String, nil]
40
+ optional :prefix, String
41
+
42
+ # @!attribute search
43
+ # Only return tags that contain this text. Every word in the value must appear in
44
+ # the tag and the last word may be incomplete, which suits search-as-you-type.
45
+ # Matching is case-insensitive.
46
+ #
47
+ # @return [String, nil]
48
+ optional :search, String
49
+
50
+ # @!attribute sort
51
+ # Sort the results.
52
+ #
53
+ # - `ASC_NAME` / `DESC_NAME` — by `name`
54
+ # - `ASC_LAST_USED` / `DESC_LAST_USED` — by `lastUsedAt` within the requested
55
+ # `tagSource` and `fileType`, ties broken by `name`
56
+ #
57
+ # @return [Symbol, Imagekitio::Models::TagListParams::Sort, nil]
58
+ optional :sort, enum: -> { Imagekitio::TagListParams::Sort }
59
+
60
+ # @!attribute tag_source
61
+ # Filter tags by who added them.
62
+ #
63
+ # - `user` — tags added by users through the dashboard or the API
64
+ # - `ai` — tags added by AI auto-tagging extensions
65
+ # - `all` — both
66
+ #
67
+ # @return [Symbol, Imagekitio::Models::TagListParams::TagSource, nil]
68
+ optional :tag_source, enum: -> { Imagekitio::TagListParams::TagSource }
69
+
70
+ # @!method initialize(cursor: nil, file_type: nil, limit: nil, prefix: nil, search: nil, sort: nil, tag_source: nil, request_options: {})
71
+ # Some parameter documentations has been truncated, see
72
+ # {Imagekitio::Models::TagListParams} for more details.
73
+ #
74
+ # @param cursor [String] The `nextCursor` value from the previous response, to fetch the next page. A cur
75
+ #
76
+ # @param file_type [Symbol, Imagekitio::Models::TagListParams::FileType] Filter tags by the type of asset they are applied to.
77
+ #
78
+ # @param limit [Integer] The maximum number of tags to return in response.
79
+ #
80
+ # @param prefix [String] Only return tags that begin with this value. Matching is case-insensitive.
81
+ #
82
+ # @param search [String] Only return tags that contain this text. Every word in the value must appear in
83
+ #
84
+ # @param sort [Symbol, Imagekitio::Models::TagListParams::Sort] Sort the results.
85
+ #
86
+ # @param tag_source [Symbol, Imagekitio::Models::TagListParams::TagSource] Filter tags by who added them.
87
+ #
88
+ # @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}]
89
+
90
+ # Filter tags by the type of asset they are applied to.
91
+ #
92
+ # - `image` — tags in use on images
93
+ # - `video` — tags in use on videos
94
+ # - `static` — tags in use on any other file, such as documents, scripts and
95
+ # stylesheets
96
+ # - `all` — tags in use on any asset
97
+ module FileType
98
+ extend Imagekitio::Internal::Type::Enum
99
+
100
+ IMAGE = :image
101
+ VIDEO = :video
102
+ STATIC = :static
103
+ ALL = :all
104
+
105
+ # @!method self.values
106
+ # @return [Array<Symbol>]
107
+ end
108
+
109
+ # Sort the results.
110
+ #
111
+ # - `ASC_NAME` / `DESC_NAME` — by `name`
112
+ # - `ASC_LAST_USED` / `DESC_LAST_USED` — by `lastUsedAt` within the requested
113
+ # `tagSource` and `fileType`, ties broken by `name`
114
+ module Sort
115
+ extend Imagekitio::Internal::Type::Enum
116
+
117
+ ASC_NAME = :ASC_NAME
118
+ DESC_NAME = :DESC_NAME
119
+ ASC_LAST_USED = :ASC_LAST_USED
120
+ DESC_LAST_USED = :DESC_LAST_USED
121
+
122
+ # @!method self.values
123
+ # @return [Array<Symbol>]
124
+ end
125
+
126
+ # Filter tags by who added them.
127
+ #
128
+ # - `user` — tags added by users through the dashboard or the API
129
+ # - `ai` — tags added by AI auto-tagging extensions
130
+ # - `all` — both
131
+ module TagSource
132
+ extend Imagekitio::Internal::Type::Enum
133
+
134
+ USER = :user
135
+ AI = :ai
136
+ ALL = :all
137
+
138
+ # @!method self.values
139
+ # @return [Array<Symbol>]
140
+ end
141
+ end
142
+ end
143
+ end
@@ -46,8 +46,17 @@ module Imagekitio
46
46
  # Triggered when a file version is deleted.
47
47
  variant -> { Imagekitio::FileVersionDeleteEvent }
48
48
 
49
+ # Triggered when a folder is created, whether explicitly, by copying or moving a folder, or implicitly when an upload creates missing parent folders. Copying or moving a folder tree sends one event per folder in the tree.
50
+ variant -> { Imagekitio::FolderCreateEvent }
51
+
52
+ # Triggered when a folder is updated, for example when its custom metadata changes or it is renamed. Renaming a folder sends one event per folder in the tree, each with its new `folderPath`.
53
+ variant -> { Imagekitio::FolderUpdateEvent }
54
+
55
+ # Triggered when a folder is deleted. Deleting a folder tree sends one event per folder in the tree; the files inside it send `file.deleted` events and their versions send `file-version.deleted` events. Moving a folder sends this event for the old `folderId` and `folder.created` for the new one.
56
+ variant -> { Imagekitio::FolderDeleteEvent }
57
+
49
58
  # @!method self.variants
50
- # @return [Array(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)]
59
+ # @return [Array(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, Imagekitio::Models::FolderCreateEvent, Imagekitio::Models::FolderUpdateEvent, Imagekitio::Models::FolderDeleteEvent)]
51
60
  end
52
61
  end
53
62
  end
@@ -46,8 +46,17 @@ module Imagekitio
46
46
  # Triggered when a file version is deleted.
47
47
  variant -> { Imagekitio::FileVersionDeleteEvent }
48
48
 
49
+ # Triggered when a folder is created, whether explicitly, by copying or moving a folder, or implicitly when an upload creates missing parent folders. Copying or moving a folder tree sends one event per folder in the tree.
50
+ variant -> { Imagekitio::FolderCreateEvent }
51
+
52
+ # Triggered when a folder is updated, for example when its custom metadata changes or it is renamed. Renaming a folder sends one event per folder in the tree, each with its new `folderPath`.
53
+ variant -> { Imagekitio::FolderUpdateEvent }
54
+
55
+ # Triggered when a folder is deleted. Deleting a folder tree sends one event per folder in the tree; the files inside it send `file.deleted` events and their versions send `file-version.deleted` events. Moving a folder sends this event for the old `folderId` and `folder.created` for the new one.
56
+ variant -> { Imagekitio::FolderDeleteEvent }
57
+
49
58
  # @!method self.variants
50
- # @return [Array(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)]
59
+ # @return [Array(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, Imagekitio::Models::FolderCreateEvent, Imagekitio::Models::FolderUpdateEvent, Imagekitio::Models::FolderDeleteEvent)]
51
60
  end
52
61
  end
53
62
  end
@@ -23,6 +23,11 @@ module Imagekitio
23
23
  # value for that key. Before setting any custom metadata on an asset you have to
24
24
  # create the field using custom metadata fields API.
25
25
  #
26
+ # To preserve the original creation date of an asset migrated from another system,
27
+ # set the reserved `_internal_original_created_datetime` key to an ISO 8601 date
28
+ # string. This key is available once the original creation date setting is enabled
29
+ # in the media library settings.
30
+ #
26
31
  # @return [Hash{Symbol=>Object}, nil]
27
32
  optional :custom_metadata,
28
33
  Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown],
@@ -108,8 +108,12 @@ module Imagekitio
108
108
 
109
109
  FolderCopyParams = Imagekitio::Models::FolderCopyParams
110
110
 
111
+ FolderCreateEvent = Imagekitio::Models::FolderCreateEvent
112
+
111
113
  FolderCreateParams = Imagekitio::Models::FolderCreateParams
112
114
 
115
+ FolderDeleteEvent = Imagekitio::Models::FolderDeleteEvent
116
+
113
117
  FolderDeleteParams = Imagekitio::Models::FolderDeleteParams
114
118
 
115
119
  FolderMoveParams = Imagekitio::Models::FolderMoveParams
@@ -118,6 +122,8 @@ module Imagekitio
118
122
 
119
123
  Folders = Imagekitio::Models::Folders
120
124
 
125
+ FolderUpdateEvent = Imagekitio::Models::FolderUpdateEvent
126
+
121
127
  GetImageAttributesOptions = Imagekitio::Models::GetImageAttributesOptions
122
128
 
123
129
  ImageOverlay = Imagekitio::Models::ImageOverlay
@@ -173,6 +179,10 @@ module Imagekitio
173
179
 
174
180
  SubtitleOverlayTransformation = Imagekitio::Models::SubtitleOverlayTransformation
175
181
 
182
+ Tag = Imagekitio::Models::Tag
183
+
184
+ TagListParams = Imagekitio::Models::TagListParams
185
+
176
186
  TextOverlay = Imagekitio::Models::TextOverlay
177
187
 
178
188
  TextOverlayTransformation = Imagekitio::Models::TextOverlayTransformation