Skip to content

Commit d3b3ff1

Browse files
update docs
1 parent b4d4177 commit d3b3ff1

File tree

2 files changed

+158
-28
lines changed

2 files changed

+158
-28
lines changed

docs/Classes/InPlayer/Account.html

+79-14
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ <h4>Return Value</h4>
461461
<code>
462462
<a name="/s:11InPlayerSDK0aB0C7AccountC6signUp8fullName5email8password0J12Confirmation8metadata7success7failureySS_S3SSDySSypGSgyAA0aB13AuthorizationVcyAA0aB5Error_pctFZ"></a>
463463
<a name="//apple_ref/swift/Method/signUp(fullName:email:password:passwordConfirmation:metadata:success:failure:)" class="dashAnchor"></a>
464-
<a class="token" href="#/s:11InPlayerSDK0aB0C7AccountC6signUp8fullName5email8password0J12Confirmation8metadata7success7failureySS_S3SSDySSypGSgyAA0aB13AuthorizationVcyAA0aB5Error_pctFZ">signUp(fullName:email:password:passwordConfirmation:metadata:success:failure:)</a>
464+
<a class="token" href="#/s:11InPlayerSDK0aB0C7AccountC6signUp8fullName5email8password0J12Confirmation8metadata7success7failureySS_S3SSDySSypGSgyAA0aB13AuthorizationVcyAA0aB5Error_pctFZ">signUp(fullName:email:password:passwordConfirmation:brandingID:metadata:success:failure:)</a>
465465
</code>
466466
</div>
467467
<div class="height-container">
@@ -480,7 +480,7 @@ <h4>Declaration</h4>
480480
<span class="nv">email</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
481481
<span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
482482
<span class="nv">passwordConfirmation</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
483-
<span class="nv">brandingID</span><span class="p">:</span> <span class="kt">Int?</span><span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
483+
<span class="nv">brandingID</span><span class="p">:</span> <span class="kt">Int?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
484484
<span class="nv">metadata</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">Any</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
485485
<span class="nv">success</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">authorization</span><span class="p">:</span> <span class="kt"><a href="../../Structs/InPlayerAuthorization.html">InPlayerAuthorization</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
486486
<span class="nv">failure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/InPlayerError.html">InPlayerError</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
@@ -1012,6 +1012,7 @@ <h4>Declaration</h4>
10121012
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">changePassword</span><span class="p">(</span><span class="nv">oldPassword</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
10131013
<span class="nv">newPassword</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
10141014
<span class="nv">newPasswordConfirmation</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
1015+
<span class="nv">brandingID</span><span class="p">:</span> <span class="kt">Int?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
10151016
<span class="nv">success</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
10161017
<span class="nv">failure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/InPlayerError.html">InPlayerError</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
10171018

@@ -1057,6 +1058,18 @@ <h4>Parameters</h4>
10571058
</div>
10581059
</td>
10591060
</tr>
1061+
<tr>
1062+
<td>
1063+
<code>
1064+
<em>brandingID</em>
1065+
</code>
1066+
</td>
1067+
<td>
1068+
<div>
1069+
<p>Optional parameter - system branding theme ID</p>
1070+
</div>
1071+
</td>
1072+
</tr>
10601073
<tr>
10611074
<td>
10621075
<code>
@@ -1120,6 +1133,7 @@ <h4>Declaration</h4>
11201133
<div class="language">
11211134
<p class="aside-title">Swift</p>
11221135
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">deleteAccount</span><span class="p">(</span><span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
1136+
<span class="nv">brandingID</span><span class="p">:</span> <span class="kt">Int?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
11231137
<span class="nv">success</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
11241138
<span class="nv">failure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/InPlayerError.html">InPlayerError</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
11251139

@@ -1141,6 +1155,18 @@ <h4>Parameters</h4>
11411155
</div>
11421156
</td>
11431157
</tr>
1158+
<tr>
1159+
<td>
1160+
<code>
1161+
<em>brandingID</em>
1162+
</code>
1163+
</td>
1164+
<td>
1165+
<div>
1166+
<p>Optional parameter - system branding theme ID</p>
1167+
</div>
1168+
</td>
1169+
</tr>
11441170
<tr>
11451171
<td>
11461172
<code>
@@ -1206,6 +1232,7 @@ <h4>Declaration</h4>
12061232
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">setNewPassword</span><span class="p">(</span><span class="nv">token</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
12071233
<span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
12081234
<span class="nv">passwordConfirmation</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
1235+
<span class="nv">brandingID</span><span class="p">:</span> <span class="kt">Int?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
12091236
<span class="nv">success</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
12101237
<span class="nv">failure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/InPlayerError.html">InPlayerError</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
12111238

@@ -1251,6 +1278,18 @@ <h4>Parameters</h4>
12511278
</div>
12521279
</td>
12531280
</tr>
1281+
<tr>
1282+
<td>
1283+
<code>
1284+
<em>brandingID</em>
1285+
</code>
1286+
</td>
1287+
<td>
1288+
<div>
1289+
<p>Optional parameter - system branding theme ID</p>
1290+
</div>
1291+
</td>
1292+
</tr>
12541293
<tr>
12551294
<td>
12561295
<code>
@@ -1314,6 +1353,7 @@ <h4>Declaration</h4>
13141353
<div class="language">
13151354
<p class="aside-title">Swift</p>
13161355
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">requestNewPassword</span><span class="p">(</span><span class="nv">email</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
1356+
<span class="nv">brandingID</span><span class="p">:</span> <span class="kt">Int?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
13171357
<span class="nv">success</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
13181358
<span class="nv">failure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/InPlayerError.html">InPlayerError</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
13191359

@@ -1335,6 +1375,18 @@ <h4>Parameters</h4>
13351375
</div>
13361376
</td>
13371377
</tr>
1378+
<tr>
1379+
<td>
1380+
<code>
1381+
<em>brandingID</em>
1382+
</code>
1383+
</td>
1384+
<td>
1385+
<div>
1386+
<p>Optional parameter - system branding theme ID</p>
1387+
</div>
1388+
</td>
1389+
</tr>
13381390
<tr>
13391391
<td>
13401392
<code>
@@ -1495,6 +1547,7 @@ <h4>Declaration</h4>
14951547
<div class="language">
14961548
<p class="aside-title">Swift</p>
14971549
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">exportData</span><span class="p">(</span><span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
1550+
<span class="nv">brandingID</span><span class="p">:</span> <span class="kt">Int?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
14981551
<span class="nv">success</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
14991552
<span class="nv">failure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">error</span><span class="p">:</span> <span class="kt"><a href="../../Protocols/InPlayerError.html">InPlayerError</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
15001553

@@ -1516,6 +1569,18 @@ <h4>Parameters</h4>
15161569
</div>
15171570
</td>
15181571
</tr>
1572+
<tr>
1573+
<td>
1574+
<code>
1575+
<em>brandingID</em>
1576+
</code>
1577+
</td>
1578+
<td>
1579+
<div>
1580+
<p>Optional parameter - system branding theme ID</p>
1581+
</div>
1582+
</td>
1583+
</tr>
15191584
<tr>
15201585
<td>
15211586
<code>
@@ -1859,18 +1924,18 @@ <h4>Declaration</h4>
18591924
<h4>Parameters</h4>
18601925
<table class="graybox">
18611926
<tbody>
1862-
<tr>
1863-
<td>
1864-
<code>
1865-
<em>brandingID</em>
1866-
</code>
1867-
</td>
1868-
<td>
1869-
<div>
1870-
<p>Optional parameter</p>
1871-
</div>
1872-
</td>
1873-
</tr>
1927+
<tr>
1928+
<td>
1929+
<code>
1930+
<em>brandingID</em>
1931+
</code>
1932+
</td>
1933+
<td>
1934+
<div>
1935+
<p>Optional parameter - system branding theme ID</p>
1936+
</div>
1937+
</td>
1938+
</tr>
18741939
<tr>
18751940
<td>
18761941
<code>

0 commit comments

Comments
 (0)