chore: update docs (#75)

* chore: update docs * fix: fix simulated typo * chore: bump version --------- Co-authored-by: Smartcar <[email protected]>
smartcar · Nov 14, 2023 · 6964c98 · 6964c98
1 parent dee4a91
commit 6964c98
Show file tree

Hide file tree

Showing 23 changed files with 91 additions and 55 deletions.
diff --git a/SmartcarAuth.podspec b/SmartcarAuth.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'SmartcarAuth'
-  s.version          = '4.3.0'
+  s.version          = '4.3.1'
   s.summary          = 'Smartcar Authentication SDK for iOS written in Swift 5.'
 
   s.description      = <<-DESC

diff --git a/SmartcarAuth/SCMode.swift b/SmartcarAuth/SCMode.swift
@@ -23,9 +23,9 @@
 /**
  Enum to be used with the `mode` parameter for SmartcarAuth to determine which mode Connect will launch in
 
- Live: Allows users to login with a real connected services account
- Test: Allows users to connect to test vehicles using any credentials
- Simualted: Allows users to connect to simulated vehicles created on the Smartcar developer dashboard
+  - live: Allows users to login with a real connected services account
+  - test: Allows users to connect to test vehicles using any credentials
+  - simulated: Allows users to connect to simulated vehicles created on the Smartcar developer dashboard
  */
 public enum SCMode: String {
     case live

diff --git a/SmartcarAuth/SmartcarAuth.swift b/SmartcarAuth/SmartcarAuth.swift
@@ -51,7 +51,7 @@ Smartcar Authentication SDK for iOS written in Swift 5.
         - scope: An array of authorization scopes
         - completion: Callback function called upon the completion of the Smartcar Connect
         - testMode: Deprecated, please use `mode` instead. Optional, launch the Smartcar auth flow in test mode when set to true. Defaults to false.
-        - mode: Optional, determine what mode Smartcar Connect should be launched in. Should be one of test, live or simulated. If none specified, defaults to live mode.
+        - mode: Optional, determine what mode Smartcar Connect should be launched in. Should be one of .test, .live or .simulated. If none specified, defaults to live mode.
 
     */
     public init(

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -17,7 +17,7 @@
     <a title="Classes  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -200,7 +200,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/AuthorizationError.html b/docs/Classes/AuthorizationError.html
@@ -17,7 +17,7 @@
     <a title="AuthorizationError Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="../index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -170,7 +170,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/AuthorizationError/ErrorType.html b/docs/Classes/AuthorizationError/ErrorType.html
@@ -17,7 +17,7 @@
     <a title="ErrorType Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../../index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="../../index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="../../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -276,7 +276,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/SCUrlBuilder.html b/docs/Classes/SCUrlBuilder.html
@@ -17,7 +17,7 @@
     <a title="SCUrlBuilder Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="../index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -539,7 +539,7 @@ <h4>Return Value</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/SmartcarAuth.html b/docs/Classes/SmartcarAuth.html
@@ -17,7 +17,7 @@
     <a title="SmartcarAuth Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="../index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -188,7 +188,7 @@ <h4>Parameters</h4>
                               </td>
                               <td>
                                 <div>
-                                  <p>Optional, determine what mode Smartcar Connect should be launched in. Should be one of test, live or simulated. If none specified, defaults to live mode.</p>
+                                  <p>Optional, determine what mode Smartcar Connect should be launched in. Should be one of .test, .live or .simulated. If none specified, defaults to live mode.</p>
                                 </div>
                               </td>
                             </tr>
@@ -372,7 +372,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/VehicleInfo.html b/docs/Classes/VehicleInfo.html
@@ -17,7 +17,7 @@
     <a title="VehicleInfo Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="../index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -170,7 +170,7 @@ <h4>Parameters</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Enums.html b/docs/Enums.html
@@ -17,7 +17,7 @@
     <a title="Enumerations  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -90,9 +90,11 @@ <h1>Enumerations</h1>
                       <div class="abstract">
                         <p>Enum to be used with the <code>mode</code> parameter for SmartcarAuth to determine which mode Connect will launch in</p>
 
-<p>Live: Allows users to login with a real connected services account
-Test: Allows users to connect to test vehicles using any credentials
-Simualted: Allows users to connect to simulated vehicles created on the Smartcar developer dashboard</p>
+<ul>
+<li>live: Allows users to login with a real connected services account</li>
+<li>test: Allows users to connect to test vehicles using any credentials</li>
+<li>simulated: Allows users to connect to simulated vehicles created on the Smartcar developer dashboard</li>
+</ul>
 
                         <a href="Enums/SCMode.html" class="slightly-smaller">See more</a>
                       </div>
@@ -112,7 +114,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Enums/SCMode.html b/docs/Enums/SCMode.html
@@ -17,7 +17,7 @@
     <a title="SCMode Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="../index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -78,9 +78,11 @@ <h1>SCMode</h1>
               </div>
             <p>Enum to be used with the <code>mode</code> parameter for SmartcarAuth to determine which mode Connect will launch in</p>
 
-<p>Live: Allows users to login with a real connected services account
-Test: Allows users to connect to test vehicles using any credentials
-Simualted: Allows users to connect to simulated vehicles created on the Smartcar developer dashboard</p>
+<ul>
+<li>live: Allows users to login with a real connected services account</li>
+<li>test: Allows users to connect to test vehicles using any credentials</li>
+<li>simulated: Allows users to connect to simulated vehicles created on the Smartcar developer dashboard</li>
+</ul>
 
           </section>
           <section class="section task-group-section">
@@ -172,7 +174,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/docsets/SmartcarAuth.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/SmartcarAuth.docset/Contents/Resources/Documents/Classes.html
@@ -17,7 +17,7 @@
     <a title="Classes  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -200,7 +200,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/.../docsets/SmartcarAuth.docset/Contents/Resources/Documents/Classes/AuthorizationError.html b/.../docsets/SmartcarAuth.docset/Contents/Resources/Documents/Classes/AuthorizationError.html
@@ -17,7 +17,7 @@
     <a title="AuthorizationError Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="../index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -170,7 +170,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/...martcarAuth.docset/Contents/Resources/Documents/Classes/AuthorizationError/ErrorType.html b/...martcarAuth.docset/Contents/Resources/Documents/Classes/AuthorizationError/ErrorType.html
@@ -17,7 +17,7 @@
     <a title="ErrorType Enumeration Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../../index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="../../index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="../../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -276,7 +276,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/docsets/SmartcarAuth.docset/Contents/Resources/Documents/Classes/SCUrlBuilder.html b/docs/docsets/SmartcarAuth.docset/Contents/Resources/Documents/Classes/SCUrlBuilder.html
@@ -17,7 +17,7 @@
     <a title="SCUrlBuilder Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html">SmartcarAuth 4.2.0 Docs</a> (62% documented)</p>
+        <p><a href="../index.html">SmartcarAuth 4.3.0 Docs</a> (62% documented)</p>
         <div class="header-right">
           <form role="search" action="../search.json">
             <input type="text" placeholder="Search documentation" data-typeahead>
@@ -539,7 +539,7 @@ <h4>Return Value</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-13)</p>
+          <p>&copy; 2023 <a class="link" href="https://github.com/smartcar/ios-sdk" target="_blank" rel="external noopener">Smartcar Inc.</a>. All rights reserved. (Last updated: 2023-11-14)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>