Updated docs

HamblinSoft · Apr 12, 2018 · bb538a8 · bb538a8
1 parent 95170d3
commit bb538a8
Show file tree

Hide file tree

Showing 10 changed files with 18 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -120,9 +120,9 @@ teslaAPI.send(command, to: vehicle) { response in
 Send a command to a vehicle with request parameters
 
 ```swift
-let request = TKSetTemperature(driverTemp: 21.0, passengerTemp: 21.0)
+let parameters = TKSetTemperature(driverTemp: 21.0, passengerTemp: 21.0)
 
-teslaAPI.send(.setTemperature, to: vehicle, request: request) { response in
+teslaAPI.send(.setTemperature, to: vehicle, parameters: parameters) { response in
     if response.result {
         print("Command sent successfully!")
     }

diff --git a/Source/Classes/TeslaAPI.swift b/Source/Classes/TeslaAPI.swift
@@ -226,10 +226,10 @@ open class TeslaAPI {
     ///   - vehicle: The vehicle to send the command to
     ///   - request: Optional data to be included with the command
     ///   - completion: Completion Handler
-    open func send(_ command: TKCommand, to vehicle: TKVehicle, request: TKMappable? = nil, completion: @escaping (TKCommandResponse) -> Void) {
+    open func send(_ command: TKCommand, to vehicle: TKVehicle, parameters: TKMappable? = nil, completion: @escaping (TKCommandResponse) -> Void) {
         self.request(command.url(vehicleId: vehicle.id),
                      method: "POST",
-                     parameters: request?.toJSON(),
+                     parameters: parameters?.toJSON(),
                      headers: self.headers) { (httpResponse, dataOrNil: TKCommandResponse?, errorOrNil) in
 
                         defer {

diff --git a/docs/Classes/TeslaAPI.html b/docs/Classes/TeslaAPI.html
@@ -851,9 +851,9 @@ <h4>Parameters</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:8TeslaKit0A3APIC4sendyAA9TKCommandO_AA9TKVehicleV2toAA10TKMappable_pSg7requestyAA0E8ResponseVc10completiontF"></a>
-                    <a name="//apple_ref/swift/Method/send(_:to:request:completion:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:8TeslaKit0A3APIC4sendyAA9TKCommandO_AA9TKVehicleV2toAA10TKMappable_pSg7requestyAA0E8ResponseVc10completiontF">send(_:to:request:completion:)</a>
+                    <a name="/s:8TeslaKit0A3APIC4sendyAA9TKCommandO_AA9TKVehicleV2toAA10TKMappable_pSg10parametersyAA0E8ResponseVc10completiontF"></a>
+                    <a name="//apple_ref/swift/Method/send(_:to:parameters:completion:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:8TeslaKit0A3APIC4sendyAA9TKCommandO_AA9TKVehicleV2toAA10TKMappable_pSg10parametersyAA0E8ResponseVc10completiontF">send(_:to:parameters:completion:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -868,7 +868,7 @@ <h4>Parameters</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">command</span><span class="p">:</span> <span class="kt"><a href="../Enums/TKCommand.html">TKCommand</a></span><span class="p">,</span> <span class="n">to</span> <span class="nv">vehicle</span><span class="p">:</span> <span class="kt"><a href="../Structs/TKVehicle.html">TKVehicle</a></span><span class="p">,</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TKMappable.html">TKMappable</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/TKCommandResponse.html">TKCommandResponse</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
+                          <pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">command</span><span class="p">:</span> <span class="kt"><a href="../Enums/TKCommand.html">TKCommand</a></span><span class="p">,</span> <span class="n">to</span> <span class="nv">vehicle</span><span class="p">:</span> <span class="kt"><a href="../Structs/TKVehicle.html">TKVehicle</a></span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TKMappable.html">TKMappable</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/TKCommandResponse.html">TKCommandResponse</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
 
                         </div>
                       </div>

diff --git a/docs/docsets/TeslaKit.docset/Contents/Resources/Documents/Classes/TeslaAPI.html b/docs/docsets/TeslaKit.docset/Contents/Resources/Documents/Classes/TeslaAPI.html
@@ -851,9 +851,9 @@ <h4>Parameters</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:8TeslaKit0A3APIC4sendyAA9TKCommandO_AA9TKVehicleV2toAA10TKMappable_pSg7requestyAA0E8ResponseVc10completiontF"></a>
-                    <a name="//apple_ref/swift/Method/send(_:to:request:completion:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:8TeslaKit0A3APIC4sendyAA9TKCommandO_AA9TKVehicleV2toAA10TKMappable_pSg7requestyAA0E8ResponseVc10completiontF">send(_:to:request:completion:)</a>
+                    <a name="/s:8TeslaKit0A3APIC4sendyAA9TKCommandO_AA9TKVehicleV2toAA10TKMappable_pSg10parametersyAA0E8ResponseVc10completiontF"></a>
+                    <a name="//apple_ref/swift/Method/send(_:to:parameters:completion:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:8TeslaKit0A3APIC4sendyAA9TKCommandO_AA9TKVehicleV2toAA10TKMappable_pSg10parametersyAA0E8ResponseVc10completiontF">send(_:to:parameters:completion:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -868,7 +868,7 @@ <h4>Parameters</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">command</span><span class="p">:</span> <span class="kt"><a href="../Enums/TKCommand.html">TKCommand</a></span><span class="p">,</span> <span class="n">to</span> <span class="nv">vehicle</span><span class="p">:</span> <span class="kt"><a href="../Structs/TKVehicle.html">TKVehicle</a></span><span class="p">,</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TKMappable.html">TKMappable</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/TKCommandResponse.html">TKCommandResponse</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
+                          <pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">command</span><span class="p">:</span> <span class="kt"><a href="../Enums/TKCommand.html">TKCommand</a></span><span class="p">,</span> <span class="n">to</span> <span class="nv">vehicle</span><span class="p">:</span> <span class="kt"><a href="../Structs/TKVehicle.html">TKVehicle</a></span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TKMappable.html">TKMappable</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/TKCommandResponse.html">TKCommandResponse</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
 
                         </div>
                       </div>

diff --git a/docs/docsets/TeslaKit.docset/Contents/Resources/Documents/index.html b/docs/docsets/TeslaKit.docset/Contents/Resources/Documents/index.html
@@ -300,9 +300,9 @@ <h2 id='send-command' class='heading'>Send Command</h2>
 </code></pre>
 
 <p>Send a command to a vehicle with request parameters</p>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">request</span> <span class="o">=</span> <span class="kt">TKSetTemperature</span><span class="p">(</span><span class="nv">driverTemp</span><span class="p">:</span> <span class="mf">21.0</span><span class="p">,</span> <span class="nv">passengerTemp</span><span class="p">:</span> <span class="mf">21.0</span><span class="p">)</span>
+<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">parameters</span> <span class="o">=</span> <span class="kt">TKSetTemperature</span><span class="p">(</span><span class="nv">driverTemp</span><span class="p">:</span> <span class="mf">21.0</span><span class="p">,</span> <span class="nv">passengerTemp</span><span class="p">:</span> <span class="mf">21.0</span><span class="p">)</span>
 
-<span class="n">teslaAPI</span><span class="o">.</span><span class="nf">send</span><span class="p">(</span><span class="o">.</span><span class="n">setTemperature</span><span class="p">,</span> <span class="nv">to</span><span class="p">:</span> <span class="n">vehicle</span><span class="p">,</span> <span class="nv">request</span><span class="p">:</span> <span class="n">request</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
+<span class="n">teslaAPI</span><span class="o">.</span><span class="nf">send</span><span class="p">(</span><span class="o">.</span><span class="n">setTemperature</span><span class="p">,</span> <span class="nv">to</span><span class="p">:</span> <span class="n">vehicle</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="n">parameters</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
     <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">result</span> <span class="p">{</span>
         <span class="nf">print</span><span class="p">(</span><span class="s">"Command sent successfully!"</span><span class="p">)</span>
     <span class="p">}</span>

diff --git a/docs/docsets/TeslaKit.docset/Contents/Resources/Documents/search.json b/docs/docsets/TeslaKit.docset/Contents/Resources/Documents/search.json
diff --git a/docs/docsets/TeslaKit.docset/Contents/Resources/docSet.dsidx b/docs/docsets/TeslaKit.docset/Contents/Resources/docSet.dsidx
diff --git a/docs/docsets/TeslaKit.tgz b/docs/docsets/TeslaKit.tgz
diff --git a/docs/index.html b/docs/index.html
@@ -300,9 +300,9 @@ <h2 id='send-command' class='heading'>Send Command</h2>
 </code></pre>
 
 <p>Send a command to a vehicle with request parameters</p>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">request</span> <span class="o">=</span> <span class="kt">TKSetTemperature</span><span class="p">(</span><span class="nv">driverTemp</span><span class="p">:</span> <span class="mf">21.0</span><span class="p">,</span> <span class="nv">passengerTemp</span><span class="p">:</span> <span class="mf">21.0</span><span class="p">)</span>
+<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">parameters</span> <span class="o">=</span> <span class="kt">TKSetTemperature</span><span class="p">(</span><span class="nv">driverTemp</span><span class="p">:</span> <span class="mf">21.0</span><span class="p">,</span> <span class="nv">passengerTemp</span><span class="p">:</span> <span class="mf">21.0</span><span class="p">)</span>
 
-<span class="n">teslaAPI</span><span class="o">.</span><span class="nf">send</span><span class="p">(</span><span class="o">.</span><span class="n">setTemperature</span><span class="p">,</span> <span class="nv">to</span><span class="p">:</span> <span class="n">vehicle</span><span class="p">,</span> <span class="nv">request</span><span class="p">:</span> <span class="n">request</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
+<span class="n">teslaAPI</span><span class="o">.</span><span class="nf">send</span><span class="p">(</span><span class="o">.</span><span class="n">setTemperature</span><span class="p">,</span> <span class="nv">to</span><span class="p">:</span> <span class="n">vehicle</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="n">parameters</span><span class="p">)</span> <span class="p">{</span> <span class="n">response</span> <span class="k">in</span>
     <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">result</span> <span class="p">{</span>
         <span class="nf">print</span><span class="p">(</span><span class="s">"Command sent successfully!"</span><span class="p">)</span>
     <span class="p">}</span>

diff --git a/docs/search.json b/docs/search.json