Skip to content

Commit e9c632b

Browse files
committed
Update docs v2.11.0
1 parent ffe1e05 commit e9c632b

19 files changed

+59
-33
lines changed

docs/classes/Account.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/classes/Asset.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/classes/Branding.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/classes/DLC.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/classes/InPlayer.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/classes/Payment.html

+6-4
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>
@@ -364,6 +364,7 @@ <h4>Parameters:</h4>
364364
assetId: {string},
365365
accessFeeId: {string},
366366
voucherCode: {string},
367+
brandingId?: number
367368
}</li>
368369
</ul>
369370
</div>
@@ -390,7 +391,7 @@ <h4>Example:</h4>
390391

391392
<div class="example-content">
392393
<pre class="code prettyprint"><code>InPlayer.Payment
393-
.directDebitCharge({ assetId, accessFeeId, voucherCode })
394+
.directDebitCharge({ assetId, accessFeeId, voucherCode, brandingId })
394395
.then(data =&gt; console.log(data));</code></pre>
395396

396397
</div>
@@ -421,7 +422,7 @@ <h4>Example:</h4>
421422
<div class="meta">
422423
<p>
423424
Defined in
424-
<a href="../files/src_Models_Payment.js.html#l470"><code>src&#x2F;Models&#x2F;Payment.js:470</code></a>
425+
<a href="../files/src_Models_Payment.js.html#l482"><code>src&#x2F;Models&#x2F;Payment.js:482</code></a>
425426
</p>
426427

427428

@@ -445,6 +446,7 @@ <h4>Parameters:</h4>
445446
assetId: {string},
446447
accessFeeId: {string},
447448
voucherCode: {string},
449+
brandingId?: number
448450
}</li>
449451
</ul>
450452
</div>
@@ -472,7 +474,7 @@ <h4>Example:</h4>
472474

473475
<div class="example-content">
474476
<pre class="code prettyprint"><code>InPlayer.Payment
475-
.directDebitSubscribe({ assetId, accessFeeId, voucherCode })
477+
.directDebitSubscribe({ assetId, accessFeeId, voucherCode, brandingId })
476478
.then(data =&gt; console.log(data));</code></pre>
477479

478480
</div>

docs/classes/Subscription.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/classes/Voucher.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/data.json

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"project": {
33
"name": "InPlayer SDK",
44
"url": "https://inplayer-org.github.io/inplayer.js/",
5-
"version": "2.10.0",
5+
"version": "2.11.0",
66
"description": "A Javascript SDK for Inplayer's RESTful API"
77
},
88
"files": {
@@ -1194,12 +1194,12 @@
11941194
"params": [
11951195
{
11961196
"name": "data",
1197-
"description": "- Contains the data - {\n assetId: {string},\n accessFeeId: {string},\n voucherCode: {string},\n}",
1197+
"description": "- Contains the data - {\n assetId: {string},\n accessFeeId: {string},\n voucherCode: {string},\n brandingId?: number\n}",
11981198
"type": "Object"
11991199
}
12001200
],
12011201
"example": [
1202-
"\n InPlayer.Payment\n .directDebitCharge({ assetId, accessFeeId, voucherCode })\n .then(data => console.log(data));"
1202+
"\n InPlayer.Payment\n .directDebitCharge({ assetId, accessFeeId, voucherCode, brandingId })\n .then(data => console.log(data));"
12031203
],
12041204
"return": {
12051205
"description": "Contains the data - {\n code: '200',\n message: \"Submitted for payment\",\n }",
@@ -1209,20 +1209,20 @@
12091209
},
12101210
{
12111211
"file": "src/Models/Payment.js",
1212-
"line": 470,
1212+
"line": 482,
12131213
"description": "Process a request for direct debit subscribe",
12141214
"itemtype": "method",
12151215
"name": "directDebitSubscribe",
12161216
"async": 1,
12171217
"params": [
12181218
{
12191219
"name": "data",
1220-
"description": "- Contains the data - {\n assetId: {string},\n accessFeeId: {string},\n voucherCode: {string},\n}",
1220+
"description": "- Contains the data - {\n assetId: {string},\n accessFeeId: {string},\n voucherCode: {string},\n brandingId?: number\n}",
12211221
"type": "Object"
12221222
}
12231223
],
12241224
"example": [
1225-
"\n InPlayer.Payment\n .directDebitSubscribe({ assetId, accessFeeId, voucherCode })\n .then(data => console.log(data));"
1225+
"\n InPlayer.Payment\n .directDebitSubscribe({ assetId, accessFeeId, voucherCode, brandingId })\n .then(data => console.log(data));"
12261226
],
12271227
"return": {
12281228
"description": "Contains the data - {\n code: '200',\n message: \"Submitted for payment\",\n }\n }",

docs/files/src_Models_Account.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/files/src_Models_Asset.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/files/src_Models_Branding.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/files/src_Models_Dlc.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/files/src_Models_Payment.js.html

+31-7
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>
@@ -516,18 +516,24 @@ <h1>src/Models/Payment.js <small>File</small></h1>
516516
* assetId: {string},
517517
* accessFeeId: {string},
518518
* voucherCode: {string},
519+
* brandingId?: number
519520
* }
520521
* @example
521522
* InPlayer.Payment
522-
* .directDebitCharge({ assetId, accessFeeId, voucherCode })
523+
* .directDebitCharge({ assetId, accessFeeId, voucherCode, brandingId })
523524
* .then(data =&gt; console.log(data));
524525
* @return {Object} Contains the data - {
525526
* code: &#x27;200&#x27;,
526527
* message: &quot;Submitted for payment&quot;,
527528
* }
528529
*
529530
*/
530-
async directDebitCharge({ assetId: item_id, accessFeeId: access_fee_id, voucherCode: voucher_code = &#x27;&#x27; }) {
531+
async directDebitCharge({
532+
assetId: item_id,
533+
accessFeeId: access_fee_id,
534+
voucherCode: voucher_code = &#x27;&#x27;,
535+
brandingId: branding_id,
536+
}) {
531537
if (!this.Account.isAuthenticated()) {
532538
errorResponse(401, {
533539
code: 401,
@@ -543,7 +549,13 @@ <h1>src/Models/Payment.js <small>File</small></h1>
543549
Authorization: &#x60;Bearer ${this.Account.getToken().token}&#x60;,
544550
&#x27;Content-Type&#x27;: &#x27;application/x-www-form-urlencoded&#x27;
545551
},
546-
body: params({ item_id, access_fee_id, voucher_code, payment_method: &#x27;Direct Debit&#x27; }),
552+
body: params({
553+
item_id,
554+
access_fee_id,
555+
voucher_code,
556+
payment_method: &#x27;Direct Debit&#x27;,
557+
branding_id
558+
}),
547559
}
548560
);
549561

@@ -560,10 +572,11 @@ <h1>src/Models/Payment.js <small>File</small></h1>
560572
* assetId: {string},
561573
* accessFeeId: {string},
562574
* voucherCode: {string},
575+
* brandingId?: number
563576
* }
564577
* @example
565578
* InPlayer.Payment
566-
* .directDebitSubscribe({ assetId, accessFeeId, voucherCode })
579+
* .directDebitSubscribe({ assetId, accessFeeId, voucherCode, brandingId })
567580
* .then(data =&gt; console.log(data));
568581
* @return {Object} Contains the data - {
569582
* code: &#x27;200&#x27;,
@@ -572,7 +585,12 @@ <h1>src/Models/Payment.js <small>File</small></h1>
572585
* }
573586
*/
574587

575-
async directDebitSubscribe({ assetId: item_id, accessFeeId: access_fee_id, voucherCode: voucher_code = &#x27;&#x27; }) {
588+
async directDebitSubscribe({
589+
assetId: item_id,
590+
accessFeeId: access_fee_id,
591+
voucherCode: voucher_code = &#x27;&#x27;,
592+
brandingId: branding_id
593+
}) {
576594
if (!this.Account.isAuthenticated()) {
577595
errorResponse(401, {
578596
code: 401,
@@ -588,7 +606,13 @@ <h1>src/Models/Payment.js <small>File</small></h1>
588606
Authorization: &#x60;Bearer ${this.Account.getToken().token}&#x60;,
589607
&#x27;Content-Type&#x27;: &#x27;application/x-www-form-urlencoded&#x27;
590608
},
591-
body: params({ item_id, access_fee_id, voucher_code, payment_method: &#x27;Direct Debit&#x27; }),
609+
body: params({
610+
item_id,
611+
access_fee_id,
612+
voucher_code,
613+
payment_method: &#x27;Direct Debit&#x27;,
614+
branding_id
615+
}),
592616
}
593617
);
594618

docs/files/src_Models_Subscription.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/files/src_Models_Voucher.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/files/src_index.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20p
2121
<li class="divider-vertical"></li>
2222
<li>
2323
<p class="navbar-text">
24-
API Docs for Version: <b>2.10.0</b>
24+
API Docs for Version: <b>2.11.0</b>
2525
</p>
2626
</li>
2727
</div>

yuidoc.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "InPlayer SDK",
33
"url": "https://inplayer-org.github.io/inplayer.js/",
4-
"version": "2.10.0",
4+
"version": "2.11.0",
55
"options": {
66
"paths": "src",
77
"outdir": "docs/",

0 commit comments

Comments
 (0)