feat: add builder method for optional user parameter for auth url (#32)

* feat: add builder method for optional user parameter for auth url * chore: bump version in gradle.properties --------- Co-authored-by: Smartcar <[email protected]>
smartcar · Apr 2, 2024 · 027ff2e · 027ff2e
1 parent 50384b1
commit 027ff2e
Show file tree

Hide file tree

Showing 23 changed files with 83 additions and 37 deletions.
diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (smartcar-auth - 3.2.0)</title>
+<title>All Classes (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (smartcar-auth - 3.2.0)</title>
+<title>All Classes (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/com/smartcar/sdk/SmartcarAuth.AuthUrlBuilder.html b/docs/com/smartcar/sdk/SmartcarAuth.AuthUrlBuilder.html
@@ -3,21 +3,21 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>SmartcarAuth.AuthUrlBuilder (smartcar-auth - 3.2.0)</title>
+<title>SmartcarAuth.AuthUrlBuilder (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="SmartcarAuth.AuthUrlBuilder (smartcar-auth - 3.2.0)";
+            parent.document.title="SmartcarAuth.AuthUrlBuilder (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {
     }
 //-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -191,6 +191,13 @@ <h3>Method Summary</h3>
 <div class="block">Set an optional state parameter.</div>
 </td>
 </tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code><a href="../../../com/smartcar/sdk/SmartcarAuth.AuthUrlBuilder.html" title="class in com.smartcar.sdk">SmartcarAuth.AuthUrlBuilder</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/smartcar/sdk/SmartcarAuth.AuthUrlBuilder.html#setUser-java.lang.String-">setUser</a></span>(java.lang.String&nbsp;user)</code>
+<div class="block">Specify a unique identifier for the vehicle owner to track their progress through
+ Smartcar Connect.</div>
+</td>
+</tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
@@ -346,6 +353,24 @@ <h4>setFlags</h4>
 </dl>
 </li>
 </ul>
+<a name="setUser-java.lang.String-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setUser</h4>
+<pre>public&nbsp;<a href="../../../com/smartcar/sdk/SmartcarAuth.AuthUrlBuilder.html" title="class in com.smartcar.sdk">SmartcarAuth.AuthUrlBuilder</a>&nbsp;setUser(java.lang.String&nbsp;user)</pre>
+<div class="block">Specify a unique identifier for the vehicle owner to track their progress through
+ Smartcar Connect.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>user</code> - An optional unique identifier for a vehicle owner. This identifier is used to aggregate
+ analytics across Connect sessions for each vehicle owner.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a reference to this object</dd>
+</dl>
+</li>
+</ul>
 <a name="build--">
 <!--   -->
 </a>

diff --git a/docs/com/smartcar/sdk/SmartcarAuth.html b/docs/com/smartcar/sdk/SmartcarAuth.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>SmartcarAuth (smartcar-auth - 3.2.0)</title>
+<title>SmartcarAuth (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="SmartcarAuth (smartcar-auth - 3.2.0)";
+            parent.document.title="SmartcarAuth (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/com/smartcar/sdk/SmartcarCallback.html b/docs/com/smartcar/sdk/SmartcarCallback.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>SmartcarCallback (smartcar-auth - 3.2.0)</title>
+<title>SmartcarCallback (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="SmartcarCallback (smartcar-auth - 3.2.0)";
+            parent.document.title="SmartcarCallback (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/com/smartcar/sdk/SmartcarCodeReceiver.html b/docs/com/smartcar/sdk/SmartcarCodeReceiver.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>SmartcarCodeReceiver (smartcar-auth - 3.2.0)</title>
+<title>SmartcarCodeReceiver (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="SmartcarCodeReceiver (smartcar-auth - 3.2.0)";
+            parent.document.title="SmartcarCodeReceiver (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/com/smartcar/sdk/SmartcarResponse.Builder.html b/docs/com/smartcar/sdk/SmartcarResponse.Builder.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>SmartcarResponse.Builder (smartcar-auth - 3.2.0)</title>
+<title>SmartcarResponse.Builder (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="SmartcarResponse.Builder (smartcar-auth - 3.2.0)";
+            parent.document.title="SmartcarResponse.Builder (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/com/smartcar/sdk/SmartcarResponse.html b/docs/com/smartcar/sdk/SmartcarResponse.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>SmartcarResponse (smartcar-auth - 3.2.0)</title>
+<title>SmartcarResponse (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="SmartcarResponse (smartcar-auth - 3.2.0)";
+            parent.document.title="SmartcarResponse (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/com/smartcar/sdk/VehicleInfo.Builder.html b/docs/com/smartcar/sdk/VehicleInfo.Builder.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>VehicleInfo.Builder (smartcar-auth - 3.2.0)</title>
+<title>VehicleInfo.Builder (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="VehicleInfo.Builder (smartcar-auth - 3.2.0)";
+            parent.document.title="VehicleInfo.Builder (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/com/smartcar/sdk/VehicleInfo.html b/docs/com/smartcar/sdk/VehicleInfo.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>VehicleInfo (smartcar-auth - 3.2.0)</title>
+<title>VehicleInfo (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="VehicleInfo (smartcar-auth - 3.2.0)";
+            parent.document.title="VehicleInfo (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/com/smartcar/sdk/package-frame.html b/docs/com/smartcar/sdk/package-frame.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>com.smartcar.sdk (smartcar-auth - 3.2.0)</title>
+<title>com.smartcar.sdk (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/com/smartcar/sdk/package-summary.html b/docs/com/smartcar/sdk/package-summary.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>com.smartcar.sdk (smartcar-auth - 3.2.0)</title>
+<title>com.smartcar.sdk (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="com.smartcar.sdk (smartcar-auth - 3.2.0)";
+            parent.document.title="com.smartcar.sdk (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/com/smartcar/sdk/package-tree.html b/docs/com/smartcar/sdk/package-tree.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>com.smartcar.sdk Class Hierarchy (smartcar-auth - 3.2.0)</title>
+<title>com.smartcar.sdk Class Hierarchy (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="com.smartcar.sdk Class Hierarchy (smartcar-auth - 3.2.0)";
+            parent.document.title="com.smartcar.sdk Class Hierarchy (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/constant-values.html b/docs/constant-values.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Constant Field Values (smartcar-auth - 3.2.0)</title>
+<title>Constant Field Values (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Constant Field Values (smartcar-auth - 3.2.0)";
+            parent.document.title="Constant Field Values (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Deprecated List (smartcar-auth - 3.2.0)</title>
+<title>Deprecated List (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Deprecated List (smartcar-auth - 3.2.0)";
+            parent.document.title="Deprecated List (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>API Help (smartcar-auth - 3.2.0)</title>
+<title>API Help (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="API Help (smartcar-auth - 3.2.0)";
+            parent.document.title="API Help (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/docs/index-all.html b/docs/index-all.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Index (smartcar-auth - 3.2.0)</title>
+<title>Index (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Index (smartcar-auth - 3.2.0)";
+            parent.document.title="Index (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {
@@ -230,6 +230,11 @@ <h2 class="title">S</h2>
 <dd>
 <div class="block">Set an optional state parameter.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="com/smartcar/sdk/SmartcarAuth.AuthUrlBuilder.html#setUser-java.lang.String-">setUser(String)</a></span> - Method in class com.smartcar.sdk.<a href="com/smartcar/sdk/SmartcarAuth.AuthUrlBuilder.html" title="class in com.smartcar.sdk">SmartcarAuth.AuthUrlBuilder</a></dt>
+<dd>
+<div class="block">Specify a unique identifier for the vehicle owner to track their progress through
+ Smartcar Connect.</div>
+</dd>
 <dt><a href="com/smartcar/sdk/SmartcarAuth.html" title="class in com.smartcar.sdk"><span class="typeNameLink">SmartcarAuth</span></a> - Class in <a href="com/smartcar/sdk/package-summary.html">com.smartcar.sdk</a></dt>
 <dd>
 <div class="block">Main class that provides SDK access methods.</div>

diff --git a/docs/index.html b/docs/index.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>smartcar-auth - 3.2.0</title>
+<title>smartcar-auth - 3.3.0</title>
 <script type="text/javascript">
     tmpTargetPage = "" + window.location.search;
     if (tmpTargetPage != "" && tmpTargetPage != "undefined")

diff --git a/docs/overview-tree.html b/docs/overview-tree.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Class Hierarchy (smartcar-auth - 3.2.0)</title>
+<title>Class Hierarchy (smartcar-auth - 3.3.0)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Class Hierarchy (smartcar-auth - 3.2.0)";
+            parent.document.title="Class Hierarchy (smartcar-auth - 3.3.0)";
         }
     }
     catch(err) {

diff --git a/smartcar-auth/gradle.properties b/smartcar-auth/gradle.properties
@@ -1,4 +1,4 @@
 libGroup=com.smartcar.sdk
 libName=smartcar-auth
-libVersion=3.2.0
+libVersion=3.3.0
 libDescription=Smartcar Android Auth SDK
diff --git a/smartcar-auth/jacoco.exec b/smartcar-auth/jacoco.exec
diff --git a/smartcar-auth/src/main/java/com/smartcar/sdk/SmartcarAuth.java b/smartcar-auth/src/main/java/com/smartcar/sdk/SmartcarAuth.java
@@ -181,6 +181,19 @@ public AuthUrlBuilder setFlags(String[] flags) {
             return this;
         }
 
+        /**
+         * Specify a unique identifier for the vehicle owner to track their progress through
+         * Smartcar Connect.
+         *
+         * @param user An optional unique identifier for a vehicle owner. This identifier is used to aggregate
+         * analytics across Connect sessions for each vehicle owner.
+         * @return a reference to this object
+         */
+        public AuthUrlBuilder setUser(String user) {
+            uriBuilder.appendQueryParameter("user", user);
+            return this;
+        }
+
         /**
          * Build a Smartcar Connect authorization url.
          *