feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 42
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml
 openapi_spec_hash: 1d382866fce3284f26d341f112988d9d
-config_hash: 54c05a157f2cc730fac9e1df5dc3ca29
+config_hash: 29a2351fe2be89392b15719be8bc964f

README.md

@@ -29,7 +29,7 @@ require "bundler/setup"
 require "imagekit"
 
 image_kit = Imagekit::Client.new(
-  private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], # This is the default and can be omitted
+  private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"], # This is the default and can be omitted
   password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted
 )
 

lib/imagekit/client.rb

@@ -19,10 +19,10 @@ class Client < Imagekit::Internal::Transport::BaseClient
     # manage API keys in the
     # [dashboard](https://imagekit.io/dashboard/developer/api-keys).
     # @return [String]
-    attr_reader :private_api_key
+    attr_reader :private_key
 
-    # ImageKit Basic Auth only uses the username field and ignores the password. This
-    # field is unused.
+    # ImageKit Basic Auth only uses the `private_key` as username and ignores the
+    # password.
     # @return [String, nil]
     attr_reader :password
 
@@ -54,9 +54,9 @@ class Client < Imagekit::Internal::Transport::BaseClient
     #
     # @return [Hash{String=>String}]
     private def auth_headers
-      return {} if @private_api_key.nil? || @password.nil?
+      return {} if @private_key.nil? || @password.nil?
 
-      base64_credentials = ["#{@private_api_key}:#{@password}"].pack("m0")
+      base64_credentials = ["#{@private_key}:#{@password}"].pack("m0")
       {"authorization" => "Basic #{base64_credentials}"}
     end
 
@@ -67,13 +67,13 @@ def base_url_overridden? = @base_url_overridden
 
     # Creates and returns a new client for interacting with the API.
     #
-    # @param private_api_key [String, nil] Your ImageKit private API key (it starts with `private_`). You can view and
+    # @param private_key [String, nil] Your ImageKit private API key (it starts with `private_`). You can view and
     # manage API keys in the
     # [dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults to
     # `ENV["IMAGEKIT_PRIVATE_API_KEY"]`
     #
-    # @param password [String, nil] ImageKit Basic Auth only uses the username field and ignores the password. This
-    # field is unused. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
+    # @param password [String, nil] ImageKit Basic Auth only uses the `private_key` as username and ignores the
+    # password. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]`
@@ -86,7 +86,7 @@ def base_url_overridden? = @base_url_overridden
     #
     # @param max_retry_delay [Float]
     def initialize(
-      private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"],
+      private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"],
       password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"),
       base_url: ENV["IMAGE_KIT_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
@@ -98,11 +98,11 @@ def initialize(
 
       base_url ||= "https://api.imagekit.io"
 
-      if private_api_key.nil?
-        raise ArgumentError.new("private_api_key is required, and can be set via environ: \"IMAGEKIT_PRIVATE_API_KEY\"")
+      if private_key.nil?
+        raise ArgumentError.new("private_key is required, and can be set via environ: \"IMAGEKIT_PRIVATE_API_KEY\"")
       end
 
-      @private_api_key = private_api_key.to_s
+      @private_key = private_key.to_s
       @password = password.to_s
 
       super(

rbi/imagekit/client.rbi

@@ -14,10 +14,10 @@ module Imagekit
     # manage API keys in the
     # [dashboard](https://imagekit.io/dashboard/developer/api-keys).
     sig { returns(String) }
-    attr_reader :private_api_key
+    attr_reader :private_key
 
-    # ImageKit Basic Auth only uses the username field and ignores the password. This
-    # field is unused.
+    # ImageKit Basic Auth only uses the `private_key` as username and ignores the
+    # password.
     sig { returns(T.nilable(String)) }
     attr_reader :password
 
@@ -58,7 +58,7 @@ module Imagekit
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
-        private_api_key: T.nilable(String),
+        private_key: T.nilable(String),
         password: T.nilable(String),
         base_url: T.nilable(String),
         max_retries: Integer,
@@ -72,9 +72,9 @@ module Imagekit
       # manage API keys in the
       # [dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults to
       # `ENV["IMAGEKIT_PRIVATE_API_KEY"]`
-      private_api_key: ENV["IMAGEKIT_PRIVATE_API_KEY"],
-      # ImageKit Basic Auth only uses the username field and ignores the password. This
-      # field is unused. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
+      private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"],
+      # ImageKit Basic Auth only uses the `private_key` as username and ignores the
+      # password. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
       password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"),
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]`

sig/imagekit/client.rbs

@@ -8,7 +8,7 @@ module Imagekit
 
     DEFAULT_MAX_RETRY_DELAY: Float
 
-    attr_reader private_api_key: String
+    attr_reader private_key: String
 
     attr_reader password: String?
 
@@ -33,7 +33,7 @@ module Imagekit
     def base_url_overridden?: -> bool
 
     def initialize: (
-      ?private_api_key: String?,
+      ?private_key: String?,
       ?password: String?,
       ?base_url: String?,
       ?max_retries: Integer,

test/imagekit/client_test.rb

@@ -40,7 +40,7 @@ def test_client_default_request_default_retry_attempts
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password"
       )
 
@@ -57,7 +57,7 @@ def test_client_given_request_default_retry_attempts
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password",
         max_retries: 3
       )
@@ -75,7 +75,7 @@ def test_client_default_request_given_retry_attempts
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password"
       )
 
@@ -96,7 +96,7 @@ def test_client_given_request_given_retry_attempts
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password",
         max_retries: 3
       )
@@ -122,7 +122,7 @@ def test_client_retry_after_seconds
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password",
         max_retries: 1
       )
@@ -145,7 +145,7 @@ def test_client_retry_after_date
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password",
         max_retries: 1
       )
@@ -170,7 +170,7 @@ def test_client_retry_after_ms
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password",
         max_retries: 1
       )
@@ -189,7 +189,7 @@ def test_retry_count_header
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password"
       )
 
@@ -208,7 +208,7 @@ def test_omit_retry_count_header
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password"
       )
 
@@ -231,7 +231,7 @@ def test_overwrite_retry_count_header
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password"
       )
 
@@ -260,7 +260,7 @@ def test_client_redirect_307
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password"
       )
 
@@ -298,7 +298,7 @@ def test_client_redirect_303
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password"
       )
 
@@ -331,7 +331,7 @@ def test_client_redirect_auth_keep_same_origin
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password"
       )
 
@@ -367,7 +367,7 @@ def test_client_redirect_auth_strip_cross_origin
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password"
       )
 
@@ -391,7 +391,7 @@ def test_default_headers
     image_kit =
       Imagekit::Client.new(
         base_url: "http://localhost",
-        private_api_key: "My Private API Key",
+        private_key: "My Private Key",
         password: "My Password"
       )
 

test/imagekit/test_helper.rb

@@ -50,7 +50,7 @@ class Imagekit::Test::SingletonClient < Imagekit::Client
   def initialize
     super(
       base_url: Imagekit::Test::SingletonClient::TEST_API_BASE_URL,
-      private_api_key: "My Private API Key",
+      private_key: "My Private Key",
       password: "My Password"
     )
   end