Skip to content

Commit 3fdfcde

Browse files
sudo-robotsudo-robot
committed
Api documentations update (Tue Nov 12 12:18:46 UTC 2024)
#apidocs
1 parent 9ccc478 commit 3fdfcde

36 files changed

+2037
-405
lines changed

‎api-docs/mangopay2-php-sdk/MangoPay/ApiBankAccounts.html

+68-12
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,10 @@ <h2>Methods</h2>
134134

135135
</div>
136136
<div class="col-md-8">
137-
<a href="#method___construct">__construct</a>($root)
137+
<a href="#method___construct">__construct</a>(<a href="../MangoPay/MangoPayApi.html"><abbr title="MangoPay\MangoPayApi">MangoPayApi</abbr></a> $root)
138138

139-
<p>Constructor</p> </div>
139+
<p><p>Constructor
140+
Root/parent instance that holds the OAuthToken and Configuration instance</p></p> </div>
140141
<div class="col-md-2"><small>from&nbsp;<a href="../MangoPay/Libraries/ApiBase.html#method___construct">
141142
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a></small></div>
142143
</div>
@@ -219,6 +220,17 @@ <h2>Methods</h2>
219220
</div>
220221
<div class="row">
221222
<div class="col-md-2 type">
223+
<a href="../MangoPay/Libraries/Error.html"><abbr title="MangoPay\Libraries\Error">Error</abbr></a>
224+
</div>
225+
<div class="col-md-8">
226+
<a href="#method_CastResponseToError">CastResponseToError</a>(object $response)
227+
228+
<p><p>Cast response object to an error object</p></p> </div>
229+
<div class="col-md-2"><small>from&nbsp;<a href="../MangoPay/Libraries/ApiBase.html#method_CastResponseToError">
230+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a></small></div>
231+
</div>
232+
<div class="row">
233+
<div class="col-md-2 type">
222234

223235
</div>
224236
<div class="col-md-8">
@@ -304,24 +316,25 @@ <h4>Return Value</h4>
304316
<div class="method-item">
305317
<h3 id="method___construct">
306318
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method___construct">
307-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L248">at line 248</a></div>
319+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L249">at line 249</a></div>
308320
<code>
309-
<strong>__construct</strong>($root)
321+
<strong>__construct</strong>(<a href="../MangoPay/MangoPayApi.html"><abbr title="MangoPay\MangoPayApi">MangoPayApi</abbr></a> $root)
310322
</code>
311323
</h3>
312324
<div class="details">
313325

314326

315327

316328
<div class="method-description">
317-
<p>Constructor</p>
329+
<p><p>Constructor
330+
Root/parent instance that holds the OAuthToken and Configuration instance</p></p>
318331
</div>
319332
<div class="tags">
320333
<h4>Parameters</h4>
321334

322335
<table class="table table-condensed">
323336
<tr>
324-
<td></td>
337+
<td><a href="../MangoPay/MangoPayApi.html"><abbr title="MangoPay\MangoPayApi">MangoPayApi</abbr></a></td>
325338
<td>$root</td>
326339
<td></td>
327340
</tr>
@@ -338,7 +351,7 @@ <h4>Parameters</h4>
338351
<div class="method-item">
339352
<h3 id="method_GetRequestUrl">
340353
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_GetRequestUrl">
341-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L258">at line 258</a></div>
354+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L259">at line 259</a></div>
342355
<code> protected string
343356
<strong>GetRequestUrl</strong>(string $key)
344357
</code>
@@ -381,7 +394,7 @@ <h4>Return Value</h4>
381394
<div class="method-item">
382395
<h3 id="method_GetRequestType">
383396
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_GetRequestType">
384-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L268">at line 268</a></div>
397+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L269">at line 269</a></div>
385398
<code> protected <a href="../MangoPay/Libraries/RequestType.html"><abbr title="MangoPay\Libraries\RequestType">RequestType</abbr></a>
386399
<strong>GetRequestType</strong>(string $key)
387400
</code>
@@ -424,7 +437,7 @@ <h4>Return Value</h4>
424437
<div class="method-item">
425438
<h3 id="method_CreateObject">
426439
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_CreateObject">
427-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L281">at line 281</a></div>
440+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L282">at line 282</a></div>
428441
<code> protected object
429442
<strong>CreateObject</strong>(string $methodKey, object $entity, object $responseClassName = null, string $entityId = null, $subEntityId = null, $idempotencyKey = null)
430443
</code>
@@ -761,14 +774,57 @@ <h4>Return Value</h4>
761774

762775

763776

777+
</div>
778+
</div>
779+
780+
</div>
781+
<div class="method-item">
782+
<h3 id="method_CastResponseToError">
783+
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_CastResponseToError">
784+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L444">at line 444</a></div>
785+
<code> protected <a href="../MangoPay/Libraries/Error.html"><abbr title="MangoPay\Libraries\Error">Error</abbr></a>
786+
<strong>CastResponseToError</strong>(object $response)
787+
</code>
788+
</h3>
789+
<div class="details">
790+
791+
792+
793+
<div class="method-description">
794+
<p><p>Cast response object to an error object</p></p>
795+
</div>
796+
<div class="tags">
797+
<h4>Parameters</h4>
798+
799+
<table class="table table-condensed">
800+
<tr>
801+
<td>object</td>
802+
<td>$response</td>
803+
<td><p>Object from API response</p></td>
804+
</tr>
805+
</table>
806+
807+
808+
<h4>Return Value</h4>
809+
810+
<table class="table table-condensed">
811+
<tr>
812+
<td><a href="../MangoPay/Libraries/Error.html"><abbr title="MangoPay\Libraries\Error">Error</abbr></a></td>
813+
<td><p>The error</p></td>
814+
</tr>
815+
</table>
816+
817+
818+
819+
764820
</div>
765821
</div>
766822

767823
</div>
768824
<div class="method-item">
769825
<h3 id="method_CastResponseToEntity">
770826
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_CastResponseToEntity">
771-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L445">at line 445</a></div>
827+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L480">at line 480</a></div>
772828
<code> protected
773829
<strong>CastResponseToEntity</strong>(object $response, string $entityClassName, $asDependentObject = false)
774830
</code>
@@ -812,7 +868,7 @@ <h4>Parameters</h4>
812868
<div class="method-item">
813869
<h3 id="method_BuildRequestData">
814870
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_BuildRequestData">
815-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L532">at line 532</a></div>
871+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L567">at line 567</a></div>
816872
<code> protected array
817873
<strong>BuildRequestData</strong>(object $entity)
818874
</code>
@@ -855,7 +911,7 @@ <h4>Return Value</h4>
855911
<div class="method-item">
856912
<h3 id="method_GetObjectForIdempotencyUrl">
857913
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_GetObjectForIdempotencyUrl">
858-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L589">at line 589</a></div>
914+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L624">at line 624</a></div>
859915
<code> protected
860916
<strong>GetObjectForIdempotencyUrl</strong>($url)
861917
</code>

‎api-docs/mangopay2-php-sdk/MangoPay/ApiBankingAliases.html

+68-12
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,10 @@ <h2>Methods</h2>
134134

135135
</div>
136136
<div class="col-md-8">
137-
<a href="#method___construct">__construct</a>($root)
137+
<a href="#method___construct">__construct</a>(<a href="../MangoPay/MangoPayApi.html"><abbr title="MangoPay\MangoPayApi">MangoPayApi</abbr></a> $root)
138138

139-
<p>Constructor</p> </div>
139+
<p><p>Constructor
140+
Root/parent instance that holds the OAuthToken and Configuration instance</p></p> </div>
140141
<div class="col-md-2"><small>from&nbsp;<a href="../MangoPay/Libraries/ApiBase.html#method___construct">
141142
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a></small></div>
142143
</div>
@@ -219,6 +220,17 @@ <h2>Methods</h2>
219220
</div>
220221
<div class="row">
221222
<div class="col-md-2 type">
223+
<a href="../MangoPay/Libraries/Error.html"><abbr title="MangoPay\Libraries\Error">Error</abbr></a>
224+
</div>
225+
<div class="col-md-8">
226+
<a href="#method_CastResponseToError">CastResponseToError</a>(object $response)
227+
228+
<p><p>Cast response object to an error object</p></p> </div>
229+
<div class="col-md-2"><small>from&nbsp;<a href="../MangoPay/Libraries/ApiBase.html#method_CastResponseToError">
230+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a></small></div>
231+
</div>
232+
<div class="row">
233+
<div class="col-md-2 type">
222234

223235
</div>
224236
<div class="col-md-8">
@@ -334,24 +346,25 @@ <h4>Return Value</h4>
334346
<div class="method-item">
335347
<h3 id="method___construct">
336348
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method___construct">
337-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L248">at line 248</a></div>
349+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L249">at line 249</a></div>
338350
<code>
339-
<strong>__construct</strong>($root)
351+
<strong>__construct</strong>(<a href="../MangoPay/MangoPayApi.html"><abbr title="MangoPay\MangoPayApi">MangoPayApi</abbr></a> $root)
340352
</code>
341353
</h3>
342354
<div class="details">
343355

344356

345357

346358
<div class="method-description">
347-
<p>Constructor</p>
359+
<p><p>Constructor
360+
Root/parent instance that holds the OAuthToken and Configuration instance</p></p>
348361
</div>
349362
<div class="tags">
350363
<h4>Parameters</h4>
351364

352365
<table class="table table-condensed">
353366
<tr>
354-
<td></td>
367+
<td><a href="../MangoPay/MangoPayApi.html"><abbr title="MangoPay\MangoPayApi">MangoPayApi</abbr></a></td>
355368
<td>$root</td>
356369
<td></td>
357370
</tr>
@@ -368,7 +381,7 @@ <h4>Parameters</h4>
368381
<div class="method-item">
369382
<h3 id="method_GetRequestUrl">
370383
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_GetRequestUrl">
371-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L258">at line 258</a></div>
384+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L259">at line 259</a></div>
372385
<code> protected string
373386
<strong>GetRequestUrl</strong>(string $key)
374387
</code>
@@ -411,7 +424,7 @@ <h4>Return Value</h4>
411424
<div class="method-item">
412425
<h3 id="method_GetRequestType">
413426
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_GetRequestType">
414-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L268">at line 268</a></div>
427+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L269">at line 269</a></div>
415428
<code> protected <a href="../MangoPay/Libraries/RequestType.html"><abbr title="MangoPay\Libraries\RequestType">RequestType</abbr></a>
416429
<strong>GetRequestType</strong>(string $key)
417430
</code>
@@ -454,7 +467,7 @@ <h4>Return Value</h4>
454467
<div class="method-item">
455468
<h3 id="method_CreateObject">
456469
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_CreateObject">
457-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L281">at line 281</a></div>
470+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L282">at line 282</a></div>
458471
<code> protected object
459472
<strong>CreateObject</strong>(string $methodKey, object $entity, object $responseClassName = null, string $entityId = null, $subEntityId = null, $idempotencyKey = null)
460473
</code>
@@ -791,14 +804,57 @@ <h4>Return Value</h4>
791804

792805

793806

807+
</div>
808+
</div>
809+
810+
</div>
811+
<div class="method-item">
812+
<h3 id="method_CastResponseToError">
813+
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_CastResponseToError">
814+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L444">at line 444</a></div>
815+
<code> protected <a href="../MangoPay/Libraries/Error.html"><abbr title="MangoPay\Libraries\Error">Error</abbr></a>
816+
<strong>CastResponseToError</strong>(object $response)
817+
</code>
818+
</h3>
819+
<div class="details">
820+
821+
822+
823+
<div class="method-description">
824+
<p><p>Cast response object to an error object</p></p>
825+
</div>
826+
<div class="tags">
827+
<h4>Parameters</h4>
828+
829+
<table class="table table-condensed">
830+
<tr>
831+
<td>object</td>
832+
<td>$response</td>
833+
<td><p>Object from API response</p></td>
834+
</tr>
835+
</table>
836+
837+
838+
<h4>Return Value</h4>
839+
840+
<table class="table table-condensed">
841+
<tr>
842+
<td><a href="../MangoPay/Libraries/Error.html"><abbr title="MangoPay\Libraries\Error">Error</abbr></a></td>
843+
<td><p>The error</p></td>
844+
</tr>
845+
</table>
846+
847+
848+
849+
794850
</div>
795851
</div>
796852

797853
</div>
798854
<div class="method-item">
799855
<h3 id="method_CastResponseToEntity">
800856
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_CastResponseToEntity">
801-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L445">at line 445</a></div>
857+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L480">at line 480</a></div>
802858
<code> protected
803859
<strong>CastResponseToEntity</strong>(object $response, string $entityClassName, $asDependentObject = false)
804860
</code>
@@ -842,7 +898,7 @@ <h4>Parameters</h4>
842898
<div class="method-item">
843899
<h3 id="method_BuildRequestData">
844900
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_BuildRequestData">
845-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L532">at line 532</a></div>
901+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L567">at line 567</a></div>
846902
<code> protected array
847903
<strong>BuildRequestData</strong>(object $entity)
848904
</code>
@@ -885,7 +941,7 @@ <h4>Return Value</h4>
885941
<div class="method-item">
886942
<h3 id="method_GetObjectForIdempotencyUrl">
887943
<div class="location">in <a href="../MangoPay/Libraries/ApiBase.html#method_GetObjectForIdempotencyUrl">
888-
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L589">at line 589</a></div>
944+
<abbr title="MangoPay\Libraries\ApiBase">ApiBase</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/ApiBase.php#L624">at line 624</a></div>
889945
<code> protected
890946
<strong>GetObjectForIdempotencyUrl</strong>($url)
891947
</code>

0 commit comments

Comments
 (0)