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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +37 -0
- data/README.md +28 -1
- data/lib/imagekitio/client.rb +4 -0
- data/lib/imagekitio/internal/tag_cursor.rb +86 -0
- data/lib/imagekitio/models/accounts/contract_get_params.rb +16 -0
- data/lib/imagekitio/models/accounts/contract_get_response.rb +82 -0
- data/lib/imagekitio/models/accounts/contract_units.rb +42 -0
- data/lib/imagekitio/models/accounts/url_endpoint_request.rb +17 -1
- data/lib/imagekitio/models/accounts/url_endpoint_response.rb +17 -1
- data/lib/imagekitio/models/accounts/webhook.rb +81 -0
- data/lib/imagekitio/models/accounts/webhook_create_params.rb +47 -0
- data/lib/imagekitio/models/accounts/webhook_delete_params.rb +24 -0
- data/lib/imagekitio/models/accounts/webhook_event_type.rb +32 -0
- data/lib/imagekitio/models/accounts/webhook_get_params.rb +24 -0
- data/lib/imagekitio/models/accounts/webhook_list_params.rb +16 -0
- data/lib/imagekitio/models/accounts/webhook_list_response.rb +10 -0
- data/lib/imagekitio/models/accounts/webhook_update_params.rb +54 -0
- data/lib/imagekitio/models/asset_list_params.rb +18 -0
- data/lib/imagekitio/models/beta/v2/file_upload_params.rb +5 -1
- data/lib/imagekitio/models/custom_metadata_field.rb +16 -3
- data/lib/imagekitio/models/custom_metadata_field_create_params.rb +4 -0
- data/lib/imagekitio/models/file_upload_params.rb +5 -1
- data/lib/imagekitio/models/folder.rb +33 -1
- data/lib/imagekitio/models/folder_create_event.rb +35 -0
- data/lib/imagekitio/models/folder_delete_event.rb +47 -0
- data/lib/imagekitio/models/folder_update_event.rb +35 -0
- data/lib/imagekitio/models/tag.rb +52 -0
- data/lib/imagekitio/models/tag_list_params.rb +143 -0
- data/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb +10 -1
- data/lib/imagekitio/models/unwrap_webhook_event.rb +10 -1
- data/lib/imagekitio/models/update_file_request.rb +5 -0
- data/lib/imagekitio/models.rb +10 -0
- data/lib/imagekitio/resources/accounts/contract.rb +47 -0
- data/lib/imagekitio/resources/accounts/webhooks.rb +146 -0
- data/lib/imagekitio/resources/accounts.rb +8 -0
- data/lib/imagekitio/resources/custom_metadata_fields.rb +2 -2
- data/lib/imagekitio/resources/files/versions.rb +2 -2
- data/lib/imagekitio/resources/files.rb +4 -16
- data/lib/imagekitio/resources/folders.rb +2 -8
- data/lib/imagekitio/resources/tags.rb +65 -0
- data/lib/imagekitio/resources/webhooks.rb +2 -2
- data/lib/imagekitio/version.rb +1 -1
- data/lib/imagekitio.rb +20 -5
- data/rbi/imagekitio/client.rbi +3 -0
- data/rbi/imagekitio/internal/tag_cursor.rbi +22 -0
- data/rbi/imagekitio/models/accounts/contract_get_params.rbi +34 -0
- data/rbi/imagekitio/models/accounts/contract_get_response.rbi +126 -0
- data/rbi/imagekitio/models/accounts/contract_units.rbi +66 -0
- data/rbi/imagekitio/models/accounts/url_endpoint_request.rbi +19 -1
- data/rbi/imagekitio/models/accounts/url_endpoint_response.rbi +19 -1
- data/rbi/imagekitio/models/accounts/webhook.rbi +109 -0
- data/rbi/imagekitio/models/accounts/webhook_create_params.rbi +78 -0
- data/rbi/imagekitio/models/accounts/webhook_delete_params.rbi +45 -0
- data/rbi/imagekitio/models/accounts/webhook_event_type.rbi +101 -0
- data/rbi/imagekitio/models/accounts/webhook_get_params.rbi +45 -0
- data/rbi/imagekitio/models/accounts/webhook_list_params.rbi +34 -0
- data/rbi/imagekitio/models/accounts/webhook_list_response.rbi +13 -0
- data/rbi/imagekitio/models/accounts/webhook_update_params.rbi +98 -0
- data/rbi/imagekitio/models/asset_list_params.rbi +27 -0
- data/rbi/imagekitio/models/beta/v2/file_upload_params.rbi +10 -2
- data/rbi/imagekitio/models/custom_metadata_field.rbi +30 -4
- data/rbi/imagekitio/models/custom_metadata_field_create_params.rbi +8 -0
- data/rbi/imagekitio/models/file_upload_params.rbi +10 -2
- data/rbi/imagekitio/models/folder.rbi +49 -0
- data/rbi/imagekitio/models/folder_create_event.rbi +53 -0
- data/rbi/imagekitio/models/folder_delete_event.rbi +83 -0
- data/rbi/imagekitio/models/folder_update_event.rbi +53 -0
- data/rbi/imagekitio/models/tag.rbi +71 -0
- data/rbi/imagekitio/models/tag_list_params.rbi +236 -0
- data/rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi +4 -1
- data/rbi/imagekitio/models/unwrap_webhook_event.rbi +4 -1
- data/rbi/imagekitio/models/update_file_request.rbi +10 -0
- data/rbi/imagekitio/models.rbi +10 -0
- data/rbi/imagekitio/resources/accounts/contract.rbi +36 -0
- data/rbi/imagekitio/resources/accounts/webhooks.rbi +113 -0
- data/rbi/imagekitio/resources/accounts.rbi +6 -0
- data/rbi/imagekitio/resources/assets.rbi +9 -0
- data/rbi/imagekitio/resources/beta/v2/files.rbi +5 -1
- data/rbi/imagekitio/resources/custom_metadata_fields.rbi +5 -1
- data/rbi/imagekitio/resources/files/versions.rbi +1 -1
- data/rbi/imagekitio/resources/files.rbi +7 -3
- data/rbi/imagekitio/resources/folders.rbi +1 -1
- data/rbi/imagekitio/resources/tags.rbi +74 -0
- data/rbi/imagekitio/resources/webhooks.rbi +8 -2
- data/sig/imagekitio/client.rbs +2 -0
- data/sig/imagekitio/internal/tag_cursor.rbs +13 -0
- data/sig/imagekitio/models/accounts/contract_get_params.rbs +17 -0
- data/sig/imagekitio/models/accounts/contract_get_response.rbs +73 -0
- data/sig/imagekitio/models/accounts/contract_units.rbs +37 -0
- data/sig/imagekitio/models/accounts/url_endpoint_request.rbs +12 -2
- data/sig/imagekitio/models/accounts/url_endpoint_response.rbs +12 -2
- data/sig/imagekitio/models/accounts/webhook.rbs +52 -0
- data/sig/imagekitio/models/accounts/webhook_create_params.rbs +40 -0
- data/sig/imagekitio/models/accounts/webhook_delete_params.rbs +25 -0
- data/sig/imagekitio/models/accounts/webhook_event_type.rbs +44 -0
- data/sig/imagekitio/models/accounts/webhook_get_params.rbs +25 -0
- data/sig/imagekitio/models/accounts/webhook_list_params.rbs +17 -0
- data/sig/imagekitio/models/accounts/webhook_list_response.rbs +9 -0
- data/sig/imagekitio/models/accounts/webhook_update_params.rbs +51 -0
- data/sig/imagekitio/models/folder.rbs +32 -5
- data/sig/imagekitio/models/folder_create_event.rbs +32 -0
- data/sig/imagekitio/models/folder_delete_event.rbs +48 -0
- data/sig/imagekitio/models/folder_update_event.rbs +32 -0
- data/sig/imagekitio/models/tag.rbs +30 -0
- data/sig/imagekitio/models/tag_list_params.rbs +114 -0
- data/sig/imagekitio/models/unsafe_unwrap_webhook_event.rbs +3 -0
- data/sig/imagekitio/models/unwrap_webhook_event.rbs +3 -0
- data/sig/imagekitio/models.rbs +10 -0
- data/sig/imagekitio/resources/accounts/contract.rbs +13 -0
- data/sig/imagekitio/resources/accounts/webhooks.rbs +38 -0
- data/sig/imagekitio/resources/accounts.rbs +4 -0
- data/sig/imagekitio/resources/custom_metadata_fields.rbs +1 -4
- data/sig/imagekitio/resources/files/versions.rbs +1 -1
- data/sig/imagekitio/resources/files.rbs +2 -2
- data/sig/imagekitio/resources/folders.rbs +1 -1
- data/sig/imagekitio/resources/tags.rbs +18 -0
- data/sig/imagekitio/resources/webhooks.rbs +8 -2
- metadata +62 -17
- data/lib/imagekitio/models/custom_metadata_field_delete_response.rb +0 -10
- data/lib/imagekitio/models/file_copy_response.rb +0 -10
- data/lib/imagekitio/models/file_move_response.rb +0 -10
- data/lib/imagekitio/models/files/version_delete_response.rb +0 -12
- data/lib/imagekitio/models/folder_delete_response.rb +0 -10
- data/rbi/imagekitio/models/custom_metadata_field_delete_response.rbi +0 -23
- data/rbi/imagekitio/models/file_copy_response.rbi +0 -23
- data/rbi/imagekitio/models/file_move_response.rbi +0 -23
- data/rbi/imagekitio/models/files/version_delete_response.rbi +0 -25
- data/rbi/imagekitio/models/folder_delete_response.rbi +0 -23
- data/sig/imagekitio/models/custom_metadata_field_delete_response.rbs +0 -11
- data/sig/imagekitio/models/file_copy_response.rbs +0 -11
- data/sig/imagekitio/models/file_move_response.rbs +0 -11
- data/sig/imagekitio/models/files/version_delete_response.rbs +0 -13
- data/sig/imagekitio/models/folder_delete_response.rbs +0 -11
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Resources
|
|
5
|
+
class Accounts
|
|
6
|
+
class Contract
|
|
7
|
+
# Get the account's contract terms and the usage consumed against them in the
|
|
8
|
+
# current contract term. Bandwidth is in bytes; video processing units, extension
|
|
9
|
+
# units and purge cache requests are counts.
|
|
10
|
+
#
|
|
11
|
+
# For an agency account, consumption includes the child accounts billed to it. A
|
|
12
|
+
# child account billed to its parent cannot call this endpoint; call it with the
|
|
13
|
+
# parent account's credentials instead.
|
|
14
|
+
#
|
|
15
|
+
# Contract terms are read live; consumption is refreshed periodically, not on
|
|
16
|
+
# every request. Use `asOf` to check how fresh it is. Contracts of one month or
|
|
17
|
+
# less are reported as `hasContract: false`. The response is cached for 5 minutes
|
|
18
|
+
# per account.
|
|
19
|
+
#
|
|
20
|
+
# Requires an API key with account management access.
|
|
21
|
+
#
|
|
22
|
+
# @overload get(request_options: {})
|
|
23
|
+
#
|
|
24
|
+
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
25
|
+
#
|
|
26
|
+
# @return [Imagekitio::Models::Accounts::ContractGetResponse]
|
|
27
|
+
#
|
|
28
|
+
# @see Imagekitio::Models::Accounts::ContractGetParams
|
|
29
|
+
def get(params = {})
|
|
30
|
+
@client.request(
|
|
31
|
+
method: :get,
|
|
32
|
+
path: "v1/accounts/contract",
|
|
33
|
+
model: Imagekitio::Models::Accounts::ContractGetResponse,
|
|
34
|
+
options: params[:request_options]
|
|
35
|
+
)
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# @api private
|
|
39
|
+
#
|
|
40
|
+
# @param client [Imagekitio::Client]
|
|
41
|
+
def initialize(client:)
|
|
42
|
+
@client = client
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Resources
|
|
5
|
+
class Accounts
|
|
6
|
+
class Webhooks
|
|
7
|
+
# Some parameter documentations has been truncated, see
|
|
8
|
+
# {Imagekitio::Models::Accounts::WebhookCreateParams} for more details.
|
|
9
|
+
#
|
|
10
|
+
# Creates a new webhook and returns the created object, including the generated
|
|
11
|
+
# signing `secret`.
|
|
12
|
+
#
|
|
13
|
+
# ImageKit sends a `POST` request to the webhook `endpoint` whenever one of the
|
|
14
|
+
# subscribed `events` occurs. Use the `secret` to verify the signature of each
|
|
15
|
+
# request. Learn more about [webhooks](https://imagekit.io/docs/webhooks).
|
|
16
|
+
#
|
|
17
|
+
# You can create up to 3 webhooks per account.
|
|
18
|
+
#
|
|
19
|
+
# @overload create(endpoint:, events:, enabled: nil, request_options: {})
|
|
20
|
+
#
|
|
21
|
+
# @param endpoint [String] The URL where ImageKit sends webhook events as `POST` requests. Must use the `ht
|
|
22
|
+
#
|
|
23
|
+
# @param events [Array<Symbol, Imagekitio::Models::Accounts::WebhookEventType>] The event types this webhook is subscribed to. ImageKit sends a request to the `
|
|
24
|
+
#
|
|
25
|
+
# @param enabled [Boolean] Whether the webhook is enabled. When `false`, ImageKit doesn't send any events t
|
|
26
|
+
#
|
|
27
|
+
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
28
|
+
#
|
|
29
|
+
# @return [Imagekitio::Models::Accounts::Webhook]
|
|
30
|
+
#
|
|
31
|
+
# @see Imagekitio::Models::Accounts::WebhookCreateParams
|
|
32
|
+
def create(params)
|
|
33
|
+
parsed, options = Imagekitio::Accounts::WebhookCreateParams.dump_request(params)
|
|
34
|
+
@client.request(
|
|
35
|
+
method: :post,
|
|
36
|
+
path: "v1/accounts/webhooks",
|
|
37
|
+
body: parsed,
|
|
38
|
+
model: Imagekitio::Accounts::Webhook,
|
|
39
|
+
options: options
|
|
40
|
+
)
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# Some parameter documentations has been truncated, see
|
|
44
|
+
# {Imagekitio::Models::Accounts::WebhookUpdateParams} for more details.
|
|
45
|
+
#
|
|
46
|
+
# Updates the webhook identified by `id` and returns the updated object. Only the
|
|
47
|
+
# fields included in the request body are changed.
|
|
48
|
+
#
|
|
49
|
+
# When `events` is provided, it replaces the existing list of subscribed events.
|
|
50
|
+
# The signing `secret` can't be changed.
|
|
51
|
+
#
|
|
52
|
+
# @overload update(id, enabled: nil, endpoint: nil, events: nil, request_options: {})
|
|
53
|
+
#
|
|
54
|
+
# @param id [String] Unique identifier for a webhook.
|
|
55
|
+
#
|
|
56
|
+
# @param enabled [Boolean] Whether the webhook is enabled. Omit to leave the current value unchanged.
|
|
57
|
+
#
|
|
58
|
+
# @param endpoint [String] The URL where ImageKit sends webhook events as `POST` requests. Must use the `ht
|
|
59
|
+
#
|
|
60
|
+
# @param events [Array<Symbol, Imagekitio::Models::Accounts::WebhookEventType>] The event types this webhook is subscribed to. Replaces the existing list. Omit
|
|
61
|
+
#
|
|
62
|
+
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
63
|
+
#
|
|
64
|
+
# @return [Imagekitio::Models::Accounts::Webhook]
|
|
65
|
+
#
|
|
66
|
+
# @see Imagekitio::Models::Accounts::WebhookUpdateParams
|
|
67
|
+
def update(id, params = {})
|
|
68
|
+
parsed, options = Imagekitio::Accounts::WebhookUpdateParams.dump_request(params)
|
|
69
|
+
@client.request(
|
|
70
|
+
method: :patch,
|
|
71
|
+
path: ["v1/accounts/webhooks/%1$s", id],
|
|
72
|
+
body: parsed,
|
|
73
|
+
model: Imagekitio::Accounts::Webhook,
|
|
74
|
+
options: options
|
|
75
|
+
)
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# Returns an array of all webhooks configured for your account.
|
|
79
|
+
#
|
|
80
|
+
# @overload list(request_options: {})
|
|
81
|
+
#
|
|
82
|
+
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
83
|
+
#
|
|
84
|
+
# @return [Array<Imagekitio::Models::Accounts::Webhook>]
|
|
85
|
+
#
|
|
86
|
+
# @see Imagekitio::Models::Accounts::WebhookListParams
|
|
87
|
+
def list(params = {})
|
|
88
|
+
@client.request(
|
|
89
|
+
method: :get,
|
|
90
|
+
path: "v1/accounts/webhooks",
|
|
91
|
+
model: Imagekitio::Internal::Type::ArrayOf[Imagekitio::Accounts::Webhook],
|
|
92
|
+
options: params[:request_options]
|
|
93
|
+
)
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
# Permanently deletes the webhook identified by `id`. ImageKit stops sending
|
|
97
|
+
# events to its endpoint.
|
|
98
|
+
#
|
|
99
|
+
# @overload delete(id, request_options: {})
|
|
100
|
+
#
|
|
101
|
+
# @param id [String] Unique identifier for a webhook.
|
|
102
|
+
#
|
|
103
|
+
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
104
|
+
#
|
|
105
|
+
# @return [nil]
|
|
106
|
+
#
|
|
107
|
+
# @see Imagekitio::Models::Accounts::WebhookDeleteParams
|
|
108
|
+
def delete(id, params = {})
|
|
109
|
+
@client.request(
|
|
110
|
+
method: :delete,
|
|
111
|
+
path: ["v1/accounts/webhooks/%1$s", id],
|
|
112
|
+
model: NilClass,
|
|
113
|
+
options: params[:request_options]
|
|
114
|
+
)
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# Retrieves the webhook identified by `id`.
|
|
118
|
+
#
|
|
119
|
+
# @overload get(id, request_options: {})
|
|
120
|
+
#
|
|
121
|
+
# @param id [String] Unique identifier for a webhook.
|
|
122
|
+
#
|
|
123
|
+
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
124
|
+
#
|
|
125
|
+
# @return [Imagekitio::Models::Accounts::Webhook]
|
|
126
|
+
#
|
|
127
|
+
# @see Imagekitio::Models::Accounts::WebhookGetParams
|
|
128
|
+
def get(id, params = {})
|
|
129
|
+
@client.request(
|
|
130
|
+
method: :get,
|
|
131
|
+
path: ["v1/accounts/webhooks/%1$s", id],
|
|
132
|
+
model: Imagekitio::Accounts::Webhook,
|
|
133
|
+
options: params[:request_options]
|
|
134
|
+
)
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
# @api private
|
|
138
|
+
#
|
|
139
|
+
# @param client [Imagekitio::Client]
|
|
140
|
+
def initialize(client:)
|
|
141
|
+
@client = client
|
|
142
|
+
end
|
|
143
|
+
end
|
|
144
|
+
end
|
|
145
|
+
end
|
|
146
|
+
end
|
|
@@ -9,12 +9,18 @@ module Imagekitio
|
|
|
9
9
|
# @return [Imagekitio::Resources::Accounts::UsageAnalytics]
|
|
10
10
|
attr_reader :usage_analytics
|
|
11
11
|
|
|
12
|
+
# @return [Imagekitio::Resources::Accounts::Contract]
|
|
13
|
+
attr_reader :contract
|
|
14
|
+
|
|
12
15
|
# @return [Imagekitio::Resources::Accounts::Origins]
|
|
13
16
|
attr_reader :origins
|
|
14
17
|
|
|
15
18
|
# @return [Imagekitio::Resources::Accounts::URLEndpoints]
|
|
16
19
|
attr_reader :url_endpoints
|
|
17
20
|
|
|
21
|
+
# @return [Imagekitio::Resources::Accounts::Webhooks]
|
|
22
|
+
attr_reader :webhooks
|
|
23
|
+
|
|
18
24
|
# @api private
|
|
19
25
|
#
|
|
20
26
|
# @param client [Imagekitio::Client]
|
|
@@ -22,8 +28,10 @@ module Imagekitio
|
|
|
22
28
|
@client = client
|
|
23
29
|
@usage = Imagekitio::Resources::Accounts::Usage.new(client: client)
|
|
24
30
|
@usage_analytics = Imagekitio::Resources::Accounts::UsageAnalytics.new(client: client)
|
|
31
|
+
@contract = Imagekitio::Resources::Accounts::Contract.new(client: client)
|
|
25
32
|
@origins = Imagekitio::Resources::Accounts::Origins.new(client: client)
|
|
26
33
|
@url_endpoints = Imagekitio::Resources::Accounts::URLEndpoints.new(client: client)
|
|
34
|
+
@webhooks = Imagekitio::Resources::Accounts::Webhooks.new(client: client)
|
|
27
35
|
end
|
|
28
36
|
end
|
|
29
37
|
end
|
|
@@ -116,14 +116,14 @@ module Imagekitio
|
|
|
116
116
|
#
|
|
117
117
|
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
118
118
|
#
|
|
119
|
-
# @return [
|
|
119
|
+
# @return [nil]
|
|
120
120
|
#
|
|
121
121
|
# @see Imagekitio::Models::CustomMetadataFieldDeleteParams
|
|
122
122
|
def delete(id, params = {})
|
|
123
123
|
@client.request(
|
|
124
124
|
method: :delete,
|
|
125
125
|
path: ["v1/customMetadataFields/%1$s", id],
|
|
126
|
-
model:
|
|
126
|
+
model: NilClass,
|
|
127
127
|
options: params[:request_options]
|
|
128
128
|
)
|
|
129
129
|
end
|
|
@@ -43,7 +43,7 @@ module Imagekitio
|
|
|
43
43
|
#
|
|
44
44
|
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
45
45
|
#
|
|
46
|
-
# @return [
|
|
46
|
+
# @return [nil]
|
|
47
47
|
#
|
|
48
48
|
# @see Imagekitio::Models::Files::VersionDeleteParams
|
|
49
49
|
def delete(version_id, params)
|
|
@@ -55,7 +55,7 @@ module Imagekitio
|
|
|
55
55
|
@client.request(
|
|
56
56
|
method: :delete,
|
|
57
57
|
path: ["v1/files/%1$s/versions/%2$s", file_id, version_id],
|
|
58
|
-
model:
|
|
58
|
+
model: NilClass,
|
|
59
59
|
options: options
|
|
60
60
|
)
|
|
61
61
|
end
|
|
@@ -87,18 +87,12 @@ module Imagekitio
|
|
|
87
87
|
#
|
|
88
88
|
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
89
89
|
#
|
|
90
|
-
# @return [
|
|
90
|
+
# @return [nil]
|
|
91
91
|
#
|
|
92
92
|
# @see Imagekitio::Models::FileCopyParams
|
|
93
93
|
def copy(params)
|
|
94
94
|
parsed, options = Imagekitio::FileCopyParams.dump_request(params)
|
|
95
|
-
@client.request(
|
|
96
|
-
method: :post,
|
|
97
|
-
path: "v1/files/copy",
|
|
98
|
-
body: parsed,
|
|
99
|
-
model: Imagekitio::Models::FileCopyResponse,
|
|
100
|
-
options: options
|
|
101
|
-
)
|
|
95
|
+
@client.request(method: :post, path: "v1/files/copy", body: parsed, model: NilClass, options: options)
|
|
102
96
|
end
|
|
103
97
|
|
|
104
98
|
# Some parameter documentations has been truncated, see
|
|
@@ -141,18 +135,12 @@ module Imagekitio
|
|
|
141
135
|
#
|
|
142
136
|
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
143
137
|
#
|
|
144
|
-
# @return [
|
|
138
|
+
# @return [nil]
|
|
145
139
|
#
|
|
146
140
|
# @see Imagekitio::Models::FileMoveParams
|
|
147
141
|
def move(params)
|
|
148
142
|
parsed, options = Imagekitio::FileMoveParams.dump_request(params)
|
|
149
|
-
@client.request(
|
|
150
|
-
method: :post,
|
|
151
|
-
path: "v1/files/move",
|
|
152
|
-
body: parsed,
|
|
153
|
-
model: Imagekitio::Models::FileMoveResponse,
|
|
154
|
-
options: options
|
|
155
|
-
)
|
|
143
|
+
@client.request(method: :post, path: "v1/files/move", body: parsed, model: NilClass, options: options)
|
|
156
144
|
end
|
|
157
145
|
|
|
158
146
|
# Some parameter documentations has been truncated, see
|
|
@@ -46,18 +46,12 @@ module Imagekitio
|
|
|
46
46
|
#
|
|
47
47
|
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
48
48
|
#
|
|
49
|
-
# @return [
|
|
49
|
+
# @return [nil]
|
|
50
50
|
#
|
|
51
51
|
# @see Imagekitio::Models::FolderDeleteParams
|
|
52
52
|
def delete(params)
|
|
53
53
|
parsed, options = Imagekitio::FolderDeleteParams.dump_request(params)
|
|
54
|
-
@client.request(
|
|
55
|
-
method: :delete,
|
|
56
|
-
path: "v1/folder",
|
|
57
|
-
body: parsed,
|
|
58
|
-
model: Imagekitio::Models::FolderDeleteResponse,
|
|
59
|
-
options: options
|
|
60
|
-
)
|
|
54
|
+
@client.request(method: :delete, path: "v1/folder", body: parsed, model: NilClass, options: options)
|
|
61
55
|
end
|
|
62
56
|
|
|
63
57
|
# Some parameter documentations has been truncated, see
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Resources
|
|
5
|
+
class Tags
|
|
6
|
+
# Some parameter documentations has been truncated, see
|
|
7
|
+
# {Imagekitio::Models::TagListParams} for more details.
|
|
8
|
+
#
|
|
9
|
+
# This API lists the distinct tags in use across your media library, with the
|
|
10
|
+
# number of assets each tag is applied to and when it was last used. Tags are
|
|
11
|
+
# matched case-insensitively, so `Summer` and `summer` are one entry: `name` is
|
|
12
|
+
# the lowercased form and `label` is the spelling that was used most recently.
|
|
13
|
+
#
|
|
14
|
+
# Use `tagSource` and `fileType` to list only the tags in use on matching assets.
|
|
15
|
+
# `lastUsedAt` and the `ASC_LAST_USED` / `DESC_LAST_USED` sorts follow those
|
|
16
|
+
# filters, while `assetCount` always counts every asset carrying the tag. Use
|
|
17
|
+
# `search` or `prefix` to narrow the listing and `cursor` to page through it.
|
|
18
|
+
#
|
|
19
|
+
# Tag counts are updated asynchronously. Changes to a file's tags usually appear
|
|
20
|
+
# in this list within about a minute, but can take longer during heavy tagging
|
|
21
|
+
# activity, so a tag you just added or removed may not be reflected immediately.
|
|
22
|
+
#
|
|
23
|
+
# @overload list(cursor: nil, file_type: nil, limit: nil, prefix: nil, search: nil, sort: nil, tag_source: nil, request_options: {})
|
|
24
|
+
#
|
|
25
|
+
# @param cursor [String] The `nextCursor` value from the previous response, to fetch the next page. A cur
|
|
26
|
+
#
|
|
27
|
+
# @param file_type [Symbol, Imagekitio::Models::TagListParams::FileType] Filter tags by the type of asset they are applied to.
|
|
28
|
+
#
|
|
29
|
+
# @param limit [Integer] The maximum number of tags to return in response.
|
|
30
|
+
#
|
|
31
|
+
# @param prefix [String] Only return tags that begin with this value. Matching is case-insensitive.
|
|
32
|
+
#
|
|
33
|
+
# @param search [String] Only return tags that contain this text. Every word in the value must appear in
|
|
34
|
+
#
|
|
35
|
+
# @param sort [Symbol, Imagekitio::Models::TagListParams::Sort] Sort the results.
|
|
36
|
+
#
|
|
37
|
+
# @param tag_source [Symbol, Imagekitio::Models::TagListParams::TagSource] Filter tags by who added them.
|
|
38
|
+
#
|
|
39
|
+
# @param request_options [Imagekitio::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
40
|
+
#
|
|
41
|
+
# @return [Imagekitio::Internal::TagCursor<Imagekitio::Models::Tag>]
|
|
42
|
+
#
|
|
43
|
+
# @see Imagekitio::Models::TagListParams
|
|
44
|
+
def list(params = {})
|
|
45
|
+
parsed, options = Imagekitio::TagListParams.dump_request(params)
|
|
46
|
+
query = Imagekitio::Internal::Util.encode_query_params(parsed)
|
|
47
|
+
@client.request(
|
|
48
|
+
method: :get,
|
|
49
|
+
path: "v1/tags",
|
|
50
|
+
query: query.transform_keys(file_type: "fileType", tag_source: "tagSource"),
|
|
51
|
+
page: Imagekitio::Internal::TagCursor,
|
|
52
|
+
model: Imagekitio::Tag,
|
|
53
|
+
options: options
|
|
54
|
+
)
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# @api private
|
|
58
|
+
#
|
|
59
|
+
# @param client [Imagekitio::Client]
|
|
60
|
+
def initialize(client:)
|
|
61
|
+
@client = client
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
@@ -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, Imagekitio::Models::FileCreateEvent, Imagekitio::Models::FileUpdateEvent, Imagekitio::Models::FileDeleteEvent, Imagekitio::Models::FileVersionCreateEvent, Imagekitio::Models::FileVersionDeleteEvent]
|
|
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, Imagekitio::Models::FolderCreateEvent, Imagekitio::Models::FolderUpdateEvent, Imagekitio::Models::FolderDeleteEvent]
|
|
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,7 +17,7 @@ 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, Imagekitio::Models::FileCreateEvent, Imagekitio::Models::FileUpdateEvent, Imagekitio::Models::FileDeleteEvent, Imagekitio::Models::FileVersionCreateEvent, Imagekitio::Models::FileVersionDeleteEvent]
|
|
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, Imagekitio::Models::FolderCreateEvent, Imagekitio::Models::FolderUpdateEvent, Imagekitio::Models::FolderDeleteEvent]
|
|
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")
|
data/lib/imagekitio/version.rb
CHANGED
data/lib/imagekitio.rb
CHANGED
|
@@ -53,6 +53,7 @@ require_relative "imagekitio/errors"
|
|
|
53
53
|
require_relative "imagekitio/internal/transport/base_client"
|
|
54
54
|
require_relative "imagekitio/internal/transport/pooled_net_requester"
|
|
55
55
|
require_relative "imagekitio/client"
|
|
56
|
+
require_relative "imagekitio/internal/tag_cursor"
|
|
56
57
|
require_relative "imagekitio/models/accounts/origin_request"
|
|
57
58
|
require_relative "imagekitio/models/accounts/url_endpoint_request"
|
|
58
59
|
require_relative "imagekitio/models/accounts/request_bandwidth_entry"
|
|
@@ -61,6 +62,9 @@ require_relative "imagekitio/models/update_file_request"
|
|
|
61
62
|
require_relative "imagekitio/models/file"
|
|
62
63
|
require_relative "imagekitio/models/src_options"
|
|
63
64
|
require_relative "imagekitio/models/base_overlay"
|
|
65
|
+
require_relative "imagekitio/models/accounts/contract_get_params"
|
|
66
|
+
require_relative "imagekitio/models/accounts/contract_get_response"
|
|
67
|
+
require_relative "imagekitio/models/accounts/contract_units"
|
|
64
68
|
require_relative "imagekitio/models/accounts/origin_create_params"
|
|
65
69
|
require_relative "imagekitio/models/accounts/origin_delete_params"
|
|
66
70
|
require_relative "imagekitio/models/accounts/origin_get_params"
|
|
@@ -79,6 +83,14 @@ require_relative "imagekitio/models/accounts/usage_analytics_get_params"
|
|
|
79
83
|
require_relative "imagekitio/models/accounts/usage_analytics_response"
|
|
80
84
|
require_relative "imagekitio/models/accounts/usage_get_params"
|
|
81
85
|
require_relative "imagekitio/models/accounts/usage_get_response"
|
|
86
|
+
require_relative "imagekitio/models/accounts/webhook"
|
|
87
|
+
require_relative "imagekitio/models/accounts/webhook_create_params"
|
|
88
|
+
require_relative "imagekitio/models/accounts/webhook_delete_params"
|
|
89
|
+
require_relative "imagekitio/models/accounts/webhook_event_type"
|
|
90
|
+
require_relative "imagekitio/models/accounts/webhook_get_params"
|
|
91
|
+
require_relative "imagekitio/models/accounts/webhook_list_params"
|
|
92
|
+
require_relative "imagekitio/models/accounts/webhook_list_response"
|
|
93
|
+
require_relative "imagekitio/models/accounts/webhook_update_params"
|
|
82
94
|
require_relative "imagekitio/models/ai_tag"
|
|
83
95
|
require_relative "imagekitio/models/asset_list_params"
|
|
84
96
|
require_relative "imagekitio/models/asset_list_response"
|
|
@@ -92,7 +104,6 @@ require_relative "imagekitio/models/custom_metadata"
|
|
|
92
104
|
require_relative "imagekitio/models/custom_metadata_field"
|
|
93
105
|
require_relative "imagekitio/models/custom_metadata_field_create_params"
|
|
94
106
|
require_relative "imagekitio/models/custom_metadata_field_delete_params"
|
|
95
|
-
require_relative "imagekitio/models/custom_metadata_field_delete_response"
|
|
96
107
|
require_relative "imagekitio/models/custom_metadata_field_list_params"
|
|
97
108
|
require_relative "imagekitio/models/custom_metadata_field_list_response"
|
|
98
109
|
require_relative "imagekitio/models/custom_metadata_field_update_params"
|
|
@@ -101,13 +112,11 @@ require_relative "imagekitio/models/extension_config"
|
|
|
101
112
|
require_relative "imagekitio/models/extension_item"
|
|
102
113
|
require_relative "imagekitio/models/extensions"
|
|
103
114
|
require_relative "imagekitio/models/file_copy_params"
|
|
104
|
-
require_relative "imagekitio/models/file_copy_response"
|
|
105
115
|
require_relative "imagekitio/models/file_create_event"
|
|
106
116
|
require_relative "imagekitio/models/file_delete_event"
|
|
107
117
|
require_relative "imagekitio/models/file_delete_params"
|
|
108
118
|
require_relative "imagekitio/models/file_get_params"
|
|
109
119
|
require_relative "imagekitio/models/file_move_params"
|
|
110
|
-
require_relative "imagekitio/models/file_move_response"
|
|
111
120
|
require_relative "imagekitio/models/file_rename_params"
|
|
112
121
|
require_relative "imagekitio/models/file_rename_response"
|
|
113
122
|
require_relative "imagekitio/models/files/bulk_add_tags_params"
|
|
@@ -121,7 +130,6 @@ require_relative "imagekitio/models/files/bulk_remove_tags_response"
|
|
|
121
130
|
require_relative "imagekitio/models/files/metadata_get_from_url_params"
|
|
122
131
|
require_relative "imagekitio/models/files/metadata_get_params"
|
|
123
132
|
require_relative "imagekitio/models/files/version_delete_params"
|
|
124
|
-
require_relative "imagekitio/models/files/version_delete_response"
|
|
125
133
|
require_relative "imagekitio/models/files/version_get_params"
|
|
126
134
|
require_relative "imagekitio/models/files/version_list_params"
|
|
127
135
|
require_relative "imagekitio/models/files/version_list_response"
|
|
@@ -136,16 +144,18 @@ require_relative "imagekitio/models/file_version_delete_event"
|
|
|
136
144
|
require_relative "imagekitio/models/folder"
|
|
137
145
|
require_relative "imagekitio/models/folder_copy_params"
|
|
138
146
|
require_relative "imagekitio/models/folder_copy_response"
|
|
147
|
+
require_relative "imagekitio/models/folder_create_event"
|
|
139
148
|
require_relative "imagekitio/models/folder_create_params"
|
|
140
149
|
require_relative "imagekitio/models/folder_create_response"
|
|
150
|
+
require_relative "imagekitio/models/folder_delete_event"
|
|
141
151
|
require_relative "imagekitio/models/folder_delete_params"
|
|
142
|
-
require_relative "imagekitio/models/folder_delete_response"
|
|
143
152
|
require_relative "imagekitio/models/folder_move_params"
|
|
144
153
|
require_relative "imagekitio/models/folder_move_response"
|
|
145
154
|
require_relative "imagekitio/models/folder_rename_params"
|
|
146
155
|
require_relative "imagekitio/models/folder_rename_response"
|
|
147
156
|
require_relative "imagekitio/models/folders/job_get_params"
|
|
148
157
|
require_relative "imagekitio/models/folders/job_get_response"
|
|
158
|
+
require_relative "imagekitio/models/folder_update_event"
|
|
149
159
|
require_relative "imagekitio/models/get_image_attributes_options"
|
|
150
160
|
require_relative "imagekitio/models/image_overlay"
|
|
151
161
|
require_relative "imagekitio/models/metadata"
|
|
@@ -173,6 +183,8 @@ require_relative "imagekitio/models/solid_color_overlay_transformation"
|
|
|
173
183
|
require_relative "imagekitio/models/streaming_resolution"
|
|
174
184
|
require_relative "imagekitio/models/subtitle_overlay"
|
|
175
185
|
require_relative "imagekitio/models/subtitle_overlay_transformation"
|
|
186
|
+
require_relative "imagekitio/models/tag"
|
|
187
|
+
require_relative "imagekitio/models/tag_list_params"
|
|
176
188
|
require_relative "imagekitio/models/text_overlay"
|
|
177
189
|
require_relative "imagekitio/models/text_overlay_transformation"
|
|
178
190
|
require_relative "imagekitio/models/transformation"
|
|
@@ -192,10 +204,12 @@ require_relative "imagekitio/models/webhook_unsafe_unwrap_params"
|
|
|
192
204
|
require_relative "imagekitio/models/webhook_unwrap_params"
|
|
193
205
|
require_relative "imagekitio/models"
|
|
194
206
|
require_relative "imagekitio/resources/accounts"
|
|
207
|
+
require_relative "imagekitio/resources/accounts/contract"
|
|
195
208
|
require_relative "imagekitio/resources/accounts/origins"
|
|
196
209
|
require_relative "imagekitio/resources/accounts/url_endpoints"
|
|
197
210
|
require_relative "imagekitio/resources/accounts/usage"
|
|
198
211
|
require_relative "imagekitio/resources/accounts/usage_analytics"
|
|
212
|
+
require_relative "imagekitio/resources/accounts/webhooks"
|
|
199
213
|
require_relative "imagekitio/resources/assets"
|
|
200
214
|
require_relative "imagekitio/resources/beta"
|
|
201
215
|
require_relative "imagekitio/resources/beta/v2"
|
|
@@ -211,5 +225,6 @@ require_relative "imagekitio/resources/folders"
|
|
|
211
225
|
require_relative "imagekitio/resources/folders/job"
|
|
212
226
|
require_relative "imagekitio/resources/named_transformations"
|
|
213
227
|
require_relative "imagekitio/resources/saved_extensions"
|
|
228
|
+
require_relative "imagekitio/resources/tags"
|
|
214
229
|
require_relative "imagekitio/resources/webhooks"
|
|
215
230
|
require_relative "imagekitio/helpers/helper"
|
data/rbi/imagekitio/client.rbi
CHANGED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Internal
|
|
5
|
+
class TagCursor
|
|
6
|
+
include Imagekitio::Internal::Type::BasePage
|
|
7
|
+
|
|
8
|
+
Elem = type_member
|
|
9
|
+
|
|
10
|
+
sig { returns(T.nilable(T::Array[Elem])) }
|
|
11
|
+
attr_accessor :tags
|
|
12
|
+
|
|
13
|
+
sig { returns(T.nilable(String)) }
|
|
14
|
+
attr_accessor :next_cursor
|
|
15
|
+
|
|
16
|
+
# @api private
|
|
17
|
+
sig { returns(String) }
|
|
18
|
+
def inspect
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Models
|
|
5
|
+
module Accounts
|
|
6
|
+
class ContractGetParams < Imagekitio::Internal::Type::BaseModel
|
|
7
|
+
extend Imagekitio::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Imagekitio::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
OrHash =
|
|
11
|
+
T.type_alias do
|
|
12
|
+
T.any(
|
|
13
|
+
Imagekitio::Accounts::ContractGetParams,
|
|
14
|
+
Imagekitio::Internal::AnyHash
|
|
15
|
+
)
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
sig do
|
|
19
|
+
params(request_options: Imagekitio::RequestOptions::OrHash).returns(
|
|
20
|
+
T.attached_class
|
|
21
|
+
)
|
|
22
|
+
end
|
|
23
|
+
def self.new(request_options: {})
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
sig do
|
|
27
|
+
override.returns({ request_options: Imagekitio::RequestOptions })
|
|
28
|
+
end
|
|
29
|
+
def to_hash
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|