changes in naming

bitwarden · Sep 24, 2023 · 272d870 · 272d870
1 parent 4cc75d9
commit 272d870
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ public class PasswordlessJavaSdkExample implements Closeable {
 
     public PasswordlessClientExample() {
         PasswordlessOptions options = PasswordlessOptions.builder()
-                .apiPrivateKey("your_api_secret")
+                .apiSecret("your_api_secret")
                 .build();
 
         client = PasswordlessClientBuilder.create(options)
@@ -128,7 +128,7 @@ public class PasswordlessJavaSdkExample {
 
 ### Customization
 
-Customize `PasswordlessOptions` by providing `apiPrivateKey` with your Application's Private API Key.
+Customize `PasswordlessOptions` by providing `apiSecret` with your Application's Private API Key.
 You can also change the `apiUrl` if you prefer to self-host.
 
 Customize `PasswordlessClientBuilder` by providing `httpClient` [CloseableHttpClient][apache-http-client] instance

diff --git a/src/main/java/com/bitwarden/passwordless/PasswordlessClientBuilder.java b/src/main/java/com/bitwarden/passwordless/PasswordlessClientBuilder.java
@@ -24,7 +24,7 @@
  * <pre>
  * {@code
  * PasswordlessOptions passwordlessOptions = PasswordlessOptions.builder()
- *     .apiPrivateKey("...")
+ *     .apiSecret("...")
  *     .build();
  * PasswordlessClient passwordlessClient = PasswordlessClientBuilder.create(passwordlessOptions)
  *     .build();

diff --git a/src/main/java/com/bitwarden/passwordless/PasswordlessHttpClient.java b/src/main/java/com/bitwarden/passwordless/PasswordlessHttpClient.java
@@ -114,7 +114,7 @@ private ClassicHttpRequest createRequest(ClassicRequestBuilder requestBuilder, S
         }
 
         requestBuilder.setUri(uri);
-        requestBuilder.addHeader(new LogMaskingHeader("ApiSecret", passwordlessOptions.getApiPrivateKey()));
+        requestBuilder.addHeader(new LogMaskingHeader("ApiSecret", passwordlessOptions.getApiSecret()));
 
         if (payload != null) {
             byte[] requestBody = objectMapper.writeValueAsBytes(payload);

diff --git a/src/main/java/com/bitwarden/passwordless/PasswordlessOptions.java b/src/main/java/com/bitwarden/passwordless/PasswordlessOptions.java
@@ -19,8 +19,8 @@ public class PasswordlessOptions {
     String apiUrl = "https://v4.passwordless.dev";
 
     /**
-     * Secret API key used to authenticate with the Passwordless API.
+     * Secret key used to authenticate with the Passwordless API.
      */
     @NonNull
-    final String apiPrivateKey;
+    final String apiSecret;
 }
diff --git a/src/test/java/com/bitwarden/passwordless/PasswordlessHttpClientTest.java b/src/test/java/com/bitwarden/passwordless/PasswordlessHttpClientTest.java
@@ -387,7 +387,7 @@ private void validateRequest(ClassicHttpRequest request, String method, String p
         assertThat(request.getHeaders()).hasSize(1);
         assertThat(request.getHeader("ApiSecret")).isNotNull()
                 .extracting(Header::getValue)
-                .isEqualTo(passwordlessOptions.getApiPrivateKey());
+                .isEqualTo(passwordlessOptions.getApiSecret());
         if (payloadJson != null) {
             assertThat(request.getEntity()).isNotNull();
             assertThat(EntityUtils.toString(request.getEntity())).isEqualTo(payloadJson);

diff --git a/src/test/java/com/bitwarden/passwordless/factory/DataFactory.java b/src/test/java/com/bitwarden/passwordless/factory/DataFactory.java
@@ -18,7 +18,7 @@ public class DataFactory {
     public PasswordlessOptions passwordlessOptions(String url) {
         return PasswordlessOptions.builder()
                 .apiUrl(url)
-                .apiPrivateKey("javaapp:secret:34286d0b2cb24b8687d1639d20eb29fa")
+                .apiSecret("javaapp:secret:34286d0b2cb24b8687d1639d20eb29fa")
                 .build();
     }