Skip to content

Commit e474ef2

Browse files
feat(api): manual updates
1 parent 09a68d6 commit e474ef2

File tree

4 files changed

+53
-29
lines changed

4 files changed

+53
-29
lines changed

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 42
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml
33
openapi_spec_hash: 1d382866fce3284f26d341f112988d9d
4-
config_hash: 29a2351fe2be89392b15719be8bc964f
4+
config_hash: c9c7bed2a4341f915a2dc85958ce7f0e

image-kit-java-client-okhttp/src/main/kotlin/com/imagekit/api/client/okhttp/ImageKitOkHttpClient.kt

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -184,13 +184,15 @@ class ImageKitOkHttpClient private constructor() {
184184
fun maxRetries(maxRetries: Int) = apply { clientOptions.maxRetries(maxRetries) }
185185

186186
/**
187-
* Your ImageKit private API key (it starts with `private_`). You can view and manage API
188-
* keys in the [dashboard](https://imagekit.io/dashboard/developer/api-keys).
187+
* Your ImageKit private API key (starts with `private_`). You can find this in the
188+
* [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys).
189189
*/
190190
fun privateKey(privateKey: String) = apply { clientOptions.privateKey(privateKey) }
191191

192192
/**
193-
* ImageKit Basic Auth only uses the `private_key` as username and ignores the password.
193+
* Leave this field unset. ImageKit uses Basic Authentication scheme that requires the
194+
* `private_key` as the username and empty string as the password. The password field is
195+
* automatically managed by the SDK and should not be set.
194196
*
195197
* Defaults to `"do_not_set"`.
196198
*/
@@ -200,10 +202,14 @@ class ImageKitOkHttpClient private constructor() {
200202
fun password(password: Optional<String>) = password(password.getOrNull())
201203

202204
/**
203-
* Your ImageKit webhook secret. This is used by the SDK to verify webhook signatures. It
204-
* starts with a `whsec_` prefix. You can view and manage your webhook secret in the
205-
* [dashboard](https://imagekit.io/dashboard/developer/webhooks). Treat the secret like a
206-
* password, keep it private and do not expose it publicly. Learn more about
205+
* Your ImageKit webhook secret used by the SDK to verify webhook signatures for security.
206+
* This secret starts with a `whsec_` prefix and is essential for webhook verification. You
207+
* can view and manage your webhook secret in the
208+
* [ImageKit dashboard](https://imagekit.io/dashboard/developer/webhooks).
209+
*
210+
* **Security Note**: Treat this secret like a password - keep it private and never expose
211+
* it publicly. This field is optional and only required if you plan to use webhook
212+
* signature verification. Learn more about
207213
* [webhook verification](https://imagekit.io/docs/webhooks#verify-webhook-signature).
208214
*/
209215
fun webhookSecret(webhookSecret: String?) = apply {

image-kit-java-client-okhttp/src/main/kotlin/com/imagekit/api/client/okhttp/ImageKitOkHttpClientAsync.kt

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -184,13 +184,15 @@ class ImageKitOkHttpClientAsync private constructor() {
184184
fun maxRetries(maxRetries: Int) = apply { clientOptions.maxRetries(maxRetries) }
185185

186186
/**
187-
* Your ImageKit private API key (it starts with `private_`). You can view and manage API
188-
* keys in the [dashboard](https://imagekit.io/dashboard/developer/api-keys).
187+
* Your ImageKit private API key (starts with `private_`). You can find this in the
188+
* [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys).
189189
*/
190190
fun privateKey(privateKey: String) = apply { clientOptions.privateKey(privateKey) }
191191

192192
/**
193-
* ImageKit Basic Auth only uses the `private_key` as username and ignores the password.
193+
* Leave this field unset. ImageKit uses Basic Authentication scheme that requires the
194+
* `private_key` as the username and empty string as the password. The password field is
195+
* automatically managed by the SDK and should not be set.
194196
*
195197
* Defaults to `"do_not_set"`.
196198
*/
@@ -200,10 +202,14 @@ class ImageKitOkHttpClientAsync private constructor() {
200202
fun password(password: Optional<String>) = password(password.getOrNull())
201203

202204
/**
203-
* Your ImageKit webhook secret. This is used by the SDK to verify webhook signatures. It
204-
* starts with a `whsec_` prefix. You can view and manage your webhook secret in the
205-
* [dashboard](https://imagekit.io/dashboard/developer/webhooks). Treat the secret like a
206-
* password, keep it private and do not expose it publicly. Learn more about
205+
* Your ImageKit webhook secret used by the SDK to verify webhook signatures for security.
206+
* This secret starts with a `whsec_` prefix and is essential for webhook verification. You
207+
* can view and manage your webhook secret in the
208+
* [ImageKit dashboard](https://imagekit.io/dashboard/developer/webhooks).
209+
*
210+
* **Security Note**: Treat this secret like a password - keep it private and never expose
211+
* it publicly. This field is optional and only required if you plan to use webhook
212+
* signature verification. Learn more about
207213
* [webhook verification](https://imagekit.io/docs/webhooks#verify-webhook-signature).
208214
*/
209215
fun webhookSecret(webhookSecret: String?) = apply {

image-kit-java-core/src/main/kotlin/com/imagekit/api/core/ClientOptions.kt

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ private constructor(
8585
*/
8686
@get:JvmName("maxRetries") val maxRetries: Int,
8787
/**
88-
* Your ImageKit private API key (it starts with `private_`). You can view and manage API keys
89-
* in the [dashboard](https://imagekit.io/dashboard/developer/api-keys).
88+
* Your ImageKit private API key (starts with `private_`). You can find this in the
89+
* [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys).
9090
*/
9191
@get:JvmName("privateKey") val privateKey: String,
9292
private val password: String?,
@@ -109,17 +109,23 @@ private constructor(
109109
fun baseUrlOverridden(): Boolean = baseUrl != null
110110

111111
/**
112-
* ImageKit Basic Auth only uses the `private_key` as username and ignores the password.
112+
* Leave this field unset. ImageKit uses Basic Authentication scheme that requires the
113+
* `private_key` as the username and empty string as the password. The password field is
114+
* automatically managed by the SDK and should not be set.
113115
*
114116
* Defaults to `"do_not_set"`.
115117
*/
116118
fun password(): Optional<String> = Optional.ofNullable(password)
117119

118120
/**
119-
* Your ImageKit webhook secret. This is used by the SDK to verify webhook signatures. It starts
120-
* with a `whsec_` prefix. You can view and manage your webhook secret in the
121-
* [dashboard](https://imagekit.io/dashboard/developer/webhooks). Treat the secret like a
122-
* password, keep it private and do not expose it publicly. Learn more about
121+
* Your ImageKit webhook secret used by the SDK to verify webhook signatures for security. This
122+
* secret starts with a `whsec_` prefix and is essential for webhook verification. You can view
123+
* and manage your webhook secret in the
124+
* [ImageKit dashboard](https://imagekit.io/dashboard/developer/webhooks).
125+
*
126+
* **Security Note**: Treat this secret like a password - keep it private and never expose it
127+
* publicly. This field is optional and only required if you plan to use webhook signature
128+
* verification. Learn more about
123129
* [webhook verification](https://imagekit.io/docs/webhooks#verify-webhook-signature).
124130
*/
125131
fun webhookSecret(): Optional<String> = Optional.ofNullable(webhookSecret)
@@ -277,13 +283,15 @@ private constructor(
277283
fun maxRetries(maxRetries: Int) = apply { this.maxRetries = maxRetries }
278284

279285
/**
280-
* Your ImageKit private API key (it starts with `private_`). You can view and manage API
281-
* keys in the [dashboard](https://imagekit.io/dashboard/developer/api-keys).
286+
* Your ImageKit private API key (starts with `private_`). You can find this in the
287+
* [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys).
282288
*/
283289
fun privateKey(privateKey: String) = apply { this.privateKey = privateKey }
284290

285291
/**
286-
* ImageKit Basic Auth only uses the `private_key` as username and ignores the password.
292+
* Leave this field unset. ImageKit uses Basic Authentication scheme that requires the
293+
* `private_key` as the username and empty string as the password. The password field is
294+
* automatically managed by the SDK and should not be set.
287295
*
288296
* Defaults to `"do_not_set"`.
289297
*/
@@ -293,10 +301,14 @@ private constructor(
293301
fun password(password: Optional<String>) = password(password.getOrNull())
294302

295303
/**
296-
* Your ImageKit webhook secret. This is used by the SDK to verify webhook signatures. It
297-
* starts with a `whsec_` prefix. You can view and manage your webhook secret in the
298-
* [dashboard](https://imagekit.io/dashboard/developer/webhooks). Treat the secret like a
299-
* password, keep it private and do not expose it publicly. Learn more about
304+
* Your ImageKit webhook secret used by the SDK to verify webhook signatures for security.
305+
* This secret starts with a `whsec_` prefix and is essential for webhook verification. You
306+
* can view and manage your webhook secret in the
307+
* [ImageKit dashboard](https://imagekit.io/dashboard/developer/webhooks).
308+
*
309+
* **Security Note**: Treat this secret like a password - keep it private and never expose
310+
* it publicly. This field is optional and only required if you plan to use webhook
311+
* signature verification. Learn more about
300312
* [webhook verification](https://imagekit.io/docs/webhooks#verify-webhook-signature).
301313
*/
302314
fun webhookSecret(webhookSecret: String?) = apply { this.webhookSecret = webhookSecret }

0 commit comments

Comments
 (0)