Skip to content

Commit af7439a

Browse files
committed
Api documentations update (Thu Jan 30 12:18:24 UTC 2025)
#apidocs
1 parent 7eab843 commit af7439a

10 files changed

+320
-9
lines changed

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

+5
Original file line numberDiff line numberDiff line change
@@ -664,6 +664,11 @@ <h2>Classes</h2>
664664
<div class="col-md-6">
665665
<a href="MangoPay/LocalAccountDetails.html"><abbr title="MangoPay\LocalAccountDetails">LocalAccountDetails</abbr></a> </div>
666666
<div class="col-md-6"></div>
667+
</div>
668+
<div class="row">
669+
<div class="col-md-6">
670+
<a href="MangoPay/LocalAccountDetailsBankingAlias.html"><abbr title="MangoPay\LocalAccountDetailsBankingAlias">LocalAccountDetailsBankingAlias</abbr></a> </div>
671+
<div class="col-md-6"></div>
667672
</div>
668673
<div class="row">
669674
<div class="col-md-6">

api-docs/mangopay2-php-sdk/MangoPay/BankingAliasIBAN.html

+10-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ <h2>Properties</h2>
157157

158158
</td>
159159
<td>$Type</td>
160-
<td class="last"><p>The type of banking alias (note that only IBAN is available at present)</p></td>
160+
<td class="last"><p>The type of banking alias (note that only IBAN and GB is available at present)</p></td>
161161
<td></td>
162162
</tr>
163163
<tr>
@@ -206,6 +206,15 @@ <h2>Properties</h2>
206206
<td>$Country</td>
207207
<td class="last"><p>The country</p></td>
208208
<td></td>
209+
</tr>
210+
<tr>
211+
<td class="type" id="property_LocalAccountDetails">
212+
<a href="../MangoPay/LocalAccountDetailsBankingAlias.html"><abbr title="MangoPay\LocalAccountDetailsBankingAlias">LocalAccountDetailsBankingAlias</abbr></a>
213+
214+
</td>
215+
<td>$LocalAccountDetails</td>
216+
<td class="last"><p>LocalAccount details used for GB</p></td>
217+
<td></td>
209218
</tr>
210219
</table>
211220

api-docs/mangopay2-php-sdk/MangoPay/BankingAliasType.html

+9
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,15 @@ <h2>Constants</h2> <table class="table table-condensed">
106106
<p><em></em></p>
107107
<p></p>
108108
</td>
109+
</tr>
110+
<tr>
111+
<td>
112+
GB
113+
</td>
114+
<td class="last">
115+
<p><em></em></p>
116+
<p></p>
117+
</td>
109118
</tr>
110119
</table>
111120

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,276 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="robots" content="index, follow, all" />
6+
<title>MangoPay\LocalAccountDetailsBankingAlias | Mangopay PHP SDK</title>
7+
8+
<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">
9+
<link rel="stylesheet" type="text/css" href="../css/bootstrap-theme.min.css">
10+
<link rel="stylesheet" type="text/css" href="../css/doctum.css">
11+
<link rel="stylesheet" type="text/css" href="../fonts/doctum-font.css">
12+
<script src="../js/jquery-3.5.1.slim.min.js"></script>
13+
<script async defer src="../doctum.js"></script>
14+
<script async defer src="../js/bootstrap.min.js"></script>
15+
<script async defer src="../js/autocomplete.min.js"></script>
16+
<meta name="MobileOptimized" content="width">
17+
<meta name="HandheldFriendly" content="true">
18+
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
19+
20+
</head>
21+
22+
<body id="class" data-name="class:MangoPay_LocalAccountDetailsBankingAlias" data-root-path="../" data-search-index-url="../doctum-search.json">
23+
<div id="content">
24+
<div id="left-column">
25+
<div id="control-panel">
26+
<div class="search-bar hidden" id="search-progress-bar-container">
27+
<div class="progress">
28+
<div class="progress-bar" role="progressbar" id="search-progress-bar"
29+
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
30+
</div>
31+
</div>
32+
<form id="search-form" action="../search.html">
33+
<span class="icon icon-search"></span>
34+
<input name="search"
35+
id="doctum-search-auto-complete"
36+
class="typeahead form-control"
37+
type="search"
38+
placeholder="Search"
39+
spellcheck="false"
40+
autocorrect="off"
41+
autocomplete="off"
42+
autocapitalize="off">
43+
<div class="auto-complete-results" id="auto-complete-results"></div>
44+
</form>
45+
</div>
46+
47+
<div id="api-tree"></div>
48+
49+
</div>
50+
<div id="right-column">
51+
<nav id="site-nav" class="navbar navbar-default" role="navigation">
52+
<div class="container-fluid">
53+
<div class="navbar-header">
54+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
55+
<span class="sr-only">Toggle navigation</span>
56+
<span class="icon-bar"></span>
57+
<span class="icon-bar"></span>
58+
<span class="icon-bar"></span>
59+
</button>
60+
<a class="navbar-brand" href="../index.html">Mangopay PHP SDK</a>
61+
</div>
62+
<div class="collapse navbar-collapse" id="navbar-elements">
63+
<ul class="nav navbar-nav">
64+
<li><a href="../classes.html">Classes</a></li>
65+
<li><a href="../namespaces.html">Namespaces</a></li>
66+
<li><a href="../interfaces.html">Interfaces</a></li>
67+
<li><a href="../traits.html">Traits</a></li>
68+
<li><a href="../doc-index.html">Index</a></li>
69+
<li><a href="../search.html">Search</a></li>
70+
</ul>
71+
</div>
72+
</div>
73+
</nav>
74+
75+
<div class="namespace-breadcrumbs">
76+
<ol class="breadcrumb">
77+
<li><span class="label label-default">class</span></li>
78+
<li><a href="../MangoPay.html">MangoPay</a></li><li class="backslash">\</li><li>LocalAccountDetailsBankingAlias</li>
79+
</ol>
80+
</div>
81+
<div id="page-content">
82+
<div class="page-header">
83+
<h1>LocalAccountDetailsBankingAlias
84+
</h1>
85+
</div>
86+
87+
88+
<p> class
89+
<strong>LocalAccountDetailsBankingAlias</strong> extends <a href="../MangoPay/Libraries/Dto.html"><abbr title="MangoPay\Libraries\Dto">Dto</abbr></a> (<a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/LocalAccountDetailsBankingAlias.php">View source</a>)
90+
</p>
91+
92+
93+
94+
95+
96+
97+
98+
99+
<h2>Properties</h2>
100+
101+
<table class="table table-condensed">
102+
<tr>
103+
<td class="type" id="property_SortCode">
104+
string
105+
106+
</td>
107+
<td>$SortCode</td>
108+
<td class="last"><p>BankingAlias GB SortCode</p></td>
109+
<td></td>
110+
</tr>
111+
<tr>
112+
<td class="type" id="property_AccountNumber">
113+
string
114+
115+
</td>
116+
<td>$AccountNumber</td>
117+
<td class="last"><p>BankingAlias GB AccountNumber</p></td>
118+
<td></td>
119+
</tr>
120+
</table>
121+
122+
123+
<h2>Methods</h2>
124+
125+
<div class="container-fluid underlined">
126+
<div class="row">
127+
<div class="col-md-2 type">
128+
array
129+
</div>
130+
<div class="col-md-8">
131+
<a href="#method_GetSubObjects">GetSubObjects</a>()
132+
133+
<p><p>Get array with mapping which property is object and what type of object.</p></p> </div>
134+
<div class="col-md-2"><small>from&nbsp;<a href="../MangoPay/Libraries/Dto.html#method_GetSubObjects">
135+
<abbr title="MangoPay\Libraries\Dto">Dto</abbr></a></small></div>
136+
</div>
137+
<div class="row">
138+
<div class="col-md-2 type">
139+
array
140+
</div>
141+
<div class="col-md-8">
142+
<a href="#method_GetDependsObjects">GetDependsObjects</a>()
143+
144+
<p><p>Get array with mapping which property depends on other property
145+
To be overridden in child class if has any dependent objects.</p></p> </div>
146+
<div class="col-md-2"><small>from&nbsp;<a href="../MangoPay/Libraries/Dto.html#method_GetDependsObjects">
147+
<abbr title="MangoPay\Libraries\Dto">Dto</abbr></a></small></div>
148+
</div>
149+
<div class="row">
150+
<div class="col-md-2 type">
151+
array
152+
</div>
153+
<div class="col-md-8">
154+
<a href="#method_GetReadOnlyProperties">GetReadOnlyProperties</a>()
155+
156+
<p><p>Get array with read only properties - not used in response
157+
To be overridden in child class if has any read-only properties.</p></p> </div>
158+
<div class="col-md-2"><small>from&nbsp;<a href="../MangoPay/Libraries/Dto.html#method_GetReadOnlyProperties">
159+
<abbr title="MangoPay\Libraries\Dto">Dto</abbr></a></small></div>
160+
</div>
161+
</div>
162+
163+
164+
<h2>Details</h2>
165+
166+
<div id="method-details">
167+
<div class="method-item">
168+
<h3 id="method_GetSubObjects">
169+
<div class="location">in <a href="../MangoPay/Libraries/Dto.html#method_GetSubObjects">
170+
<abbr title="MangoPay\Libraries\Dto">Dto</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/Dto.php#L15">at line 15</a></div>
171+
<code> array
172+
<strong>GetSubObjects</strong>()
173+
</code>
174+
</h3>
175+
<div class="details">
176+
177+
178+
179+
<div class="method-description">
180+
<p><p>Get array with mapping which property is object and what type of object.</p></p> <p><p>To be overridden in child class if has any sub objects.</p></p>
181+
</div>
182+
<div class="tags">
183+
184+
<h4>Return Value</h4>
185+
186+
<table class="table table-condensed">
187+
<tr>
188+
<td>array</td>
189+
<td></td>
190+
</tr>
191+
</table>
192+
193+
194+
195+
196+
</div>
197+
</div>
198+
199+
</div>
200+
<div class="method-item">
201+
<h3 id="method_GetDependsObjects">
202+
<div class="location">in <a href="../MangoPay/Libraries/Dto.html#method_GetDependsObjects">
203+
<abbr title="MangoPay\Libraries\Dto">Dto</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/Dto.php#L25">at line 25</a></div>
204+
<code> array
205+
<strong>GetDependsObjects</strong>()
206+
</code>
207+
</h3>
208+
<div class="details">
209+
210+
211+
212+
<div class="method-description">
213+
<p><p>Get array with mapping which property depends on other property
214+
To be overridden in child class if has any dependent objects.</p></p>
215+
</div>
216+
<div class="tags">
217+
218+
<h4>Return Value</h4>
219+
220+
<table class="table table-condensed">
221+
<tr>
222+
<td>array</td>
223+
<td></td>
224+
</tr>
225+
</table>
226+
227+
228+
229+
230+
</div>
231+
</div>
232+
233+
</div>
234+
<div class="method-item">
235+
<h3 id="method_GetReadOnlyProperties">
236+
<div class="location">in <a href="../MangoPay/Libraries/Dto.html#method_GetReadOnlyProperties">
237+
<abbr title="MangoPay\Libraries\Dto">Dto</abbr></a> <a href="https://github.com/Mangopay/mangopay2-php-sdk/blob/master/MangoPay/Libraries/Dto.php#L35">at line 35</a></div>
238+
<code> array
239+
<strong>GetReadOnlyProperties</strong>()
240+
</code>
241+
</h3>
242+
<div class="details">
243+
244+
245+
246+
<div class="method-description">
247+
<p><p>Get array with read only properties - not used in response
248+
To be overridden in child class if has any read-only properties.</p></p>
249+
</div>
250+
<div class="tags">
251+
252+
<h4>Return Value</h4>
253+
254+
<table class="table table-condensed">
255+
<tr>
256+
<td>array</td>
257+
<td></td>
258+
</tr>
259+
</table>
260+
261+
262+
263+
264+
</div>
265+
</div>
266+
267+
</div>
268+
</div>
269+
270+
271+
</div><div id="footer">
272+
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>. <br/>This documentation is built for the <a href="https://github.com/mangopay/mangopay2-php-sdk#readme" rel="noreferrer noopener" target="_blank">PHP SDK</a> of MangoPay.</div></div>
273+
</div>
274+
</body>
275+
276+
</html>

api-docs/mangopay2-php-sdk/classes.html

+5
Original file line numberDiff line numberDiff line change
@@ -770,6 +770,11 @@ <h1>Classes</h1>
770770
<div class="col-md-6">
771771
<a href="MangoPay/LocalAccountDetails.html"><abbr title="MangoPay\LocalAccountDetails">LocalAccountDetails</abbr></a> </div>
772772
<div class="col-md-6"></div>
773+
</div>
774+
<div class="row">
775+
<div class="col-md-6">
776+
<a href="MangoPay/LocalAccountDetailsBankingAlias.html"><abbr title="MangoPay\LocalAccountDetailsBankingAlias">LocalAccountDetailsBankingAlias</abbr></a> </div>
777+
<div class="col-md-6"></div>
773778
</div>
774779
<div class="row">
775780
<div class="col-md-6">

0 commit comments

Comments
 (0)