|
1156 | 1156 | <nav id="scrollingNav"> |
1157 | 1157 | <ul class="sidenav nav nav-list"> |
1158 | 1158 | <li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li> |
1159 | | - <li class="nav-header" data-group="Files"><strong>VSN: </strong>4.32.0</li> |
| 1159 | + <li class="nav-header" data-group="Files"><strong>VSN: </strong>4.33.0</li> |
1160 | 1160 | <li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li> |
1161 | 1161 | <li data-group="Files" data-name="createFileAssociation" class=""> |
1162 | 1162 | <a href="#api-Files-createFileAssociation">createFileAssociation</a> |
|
1176 | 1176 | <li data-group="Files" data-name="getAssociationsByObject" class=""> |
1177 | 1177 | <a href="#api-Files-getAssociationsByObject">getAssociationsByObject</a> |
1178 | 1178 | </li> |
| 1179 | + <li data-group="Files" data-name="getAssociationsCount" class=""> |
| 1180 | + <a href="#api-Files-getAssociationsCount">getAssociationsCount</a> |
| 1181 | + </li> |
1179 | 1182 | <li data-group="Files" data-name="getFile" class=""> |
1180 | 1183 | <a href="#api-Files-getFile">getFile</a> |
1181 | 1184 | </li> |
@@ -1858,7 +1861,7 @@ <h1>getAssociationsByObject</h1> |
1858 | 1861 | <div class="pull-right"></div> |
1859 | 1862 | <div class="clearfix"></div> |
1860 | 1863 | <p></p> |
1861 | | - <p class="marked">By passing in the appropriate options,</p> |
| 1864 | + <p class="marked">By passing in the appropriate options, you can retrieve an association</p> |
1862 | 1865 | <p></p> |
1863 | 1866 | <br /> |
1864 | 1867 | <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/{ObjectId}</span></code></pre> |
@@ -1961,6 +1964,124 @@ <h2>Parameters</h2> |
1961 | 1964 | </div> |
1962 | 1965 | </div> |
1963 | 1966 | </td> |
| 1967 | +</tr> |
| 1968 | + |
| 1969 | + </table> |
| 1970 | + </article> |
| 1971 | + </div> |
| 1972 | + <hr> |
| 1973 | + <div id="api-Files-getAssociationsCount"> |
| 1974 | + <article id="api-Files-getAssociationsCount-0" data-group="User" data-name="getAssociationsCount" data-version="0"> |
| 1975 | + <div class="pull-left"> |
| 1976 | + <h1>getAssociationsCount</h1> |
| 1977 | + <p>Retrieves a count of associations for a list of objects.</p> |
| 1978 | + </div> |
| 1979 | + <div class="pull-right"></div> |
| 1980 | + <div class="clearfix"></div> |
| 1981 | + <p></p> |
| 1982 | + <p class="marked">By passing in the appropriate options, you can retrieve the association count for objects</p> |
| 1983 | + <p></p> |
| 1984 | + <br /> |
| 1985 | + <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/Count</span></code></pre> |
| 1986 | + <p> |
| 1987 | + <h3>Usage and SDK Samples</h3> |
| 1988 | + </p> |
| 1989 | + <ul class="nav nav-tabs nav-tabs-examples"> |
| 1990 | + <!-- *****REPLACE***** comment out the other languages <li> --> |
| 1991 | + <li class=""><a href="#examples-Files-getAssociationsCount-0-javascript">Node</a></li> |
| 1992 | + </ul> |
| 1993 | + <div class="tab-content"> |
| 1994 | + <!-- *****REPLACE***** comment out the other languages tab-pane --> |
| 1995 | + <div class="tab-pane" id="examples-Files-getAssociationsCount-0-javascript"> |
| 1996 | + <pre class="prettyprint"><code class="language-javascript">await xero.setTokenSet(tokenSet); |
| 1997 | + |
| 1998 | +const xeroTenantId = 'YOUR_XERO_TENANT_ID'; |
| 1999 | +const objectIds = []; |
| 2000 | + |
| 2001 | +try { |
| 2002 | + const response = await xero.accountingApi.getAssociationsCount(xeroTenantId, objectIds); |
| 2003 | + console.log(response.body || response.response.statusCode) |
| 2004 | +} catch (err) { |
| 2005 | + const error = JSON.stringify(err.response.body, null, 2) |
| 2006 | + console.log(`Status Code: ${err.response.statusCode} => ${error}`); |
| 2007 | +}</code></pre> |
| 2008 | + </div> |
| 2009 | + </div> |
| 2010 | + <h2>Scopes</h2> |
| 2011 | + <table> |
| 2012 | + |
| 2013 | + <tr> |
| 2014 | + <td>files</td> |
| 2015 | + <td>Grant read-write access to files and folders</td> |
| 2016 | + </tr> |
| 2017 | + |
| 2018 | + <tr> |
| 2019 | + <td>files.read</td> |
| 2020 | + <td>Grant read-only access to files and folders</td> |
| 2021 | + </tr> |
| 2022 | + |
| 2023 | + </table> |
| 2024 | + <h2>Parameters</h2> |
| 2025 | + <div class="methodsubtabletitle">Header parameters</div> |
| 2026 | + <table id="methodsubtable"> |
| 2027 | + <tr> |
| 2028 | + <th width="150px">Name</th> |
| 2029 | + <th>Description</th> |
| 2030 | + </tr> |
| 2031 | + <tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td> |
| 2032 | +<td> |
| 2033 | + |
| 2034 | + |
| 2035 | + <div id="d2e199_getAssociationsCount_xeroTenantId"> |
| 2036 | + <div class="json-schema-view"> |
| 2037 | + <div class="primitive"> |
| 2038 | + <span class="type"> |
| 2039 | + String |
| 2040 | + </span> |
| 2041 | + |
| 2042 | + <div class="inner description marked"> |
| 2043 | +Xero identifier for Tenant |
| 2044 | + </div> |
| 2045 | + </div> |
| 2046 | + <div class="inner required"> |
| 2047 | + Required |
| 2048 | + </div> |
| 2049 | + </div> |
| 2050 | + </div> |
| 2051 | +</td> |
| 2052 | +</tr> |
| 2053 | + |
| 2054 | + </table> |
| 2055 | + <div class="methodsubtabletitle">Query parameters</div> |
| 2056 | + <table id="methodsubtable"> |
| 2057 | + <tr> |
| 2058 | + <th width="150px">Name</th> |
| 2059 | + <th>Description</th> |
| 2060 | + </tr> |
| 2061 | + <tr><td style="width:150px;">ObjectIds<span style="color:red;">*</span></td> |
| 2062 | +<td> |
| 2063 | + |
| 2064 | + |
| 2065 | + <div id="d2e199_getAssociationsCount_objectIds"> |
| 2066 | + <div class="json-schema-view"> |
| 2067 | + <div class="primitive"> |
| 2068 | + <span class="type"> |
| 2069 | + array[UUID] |
| 2070 | + </span> |
| 2071 | + <span class="format"> |
| 2072 | + (uuid) |
| 2073 | + </span> |
| 2074 | + |
| 2075 | + <div class="inner description marked"> |
| 2076 | +A comma-separated list of object ids |
| 2077 | + </div> |
| 2078 | + </div> |
| 2079 | + <div class="inner required"> |
| 2080 | + Required |
| 2081 | + </div> |
| 2082 | + </div> |
| 2083 | + </div> |
| 2084 | +</td> |
1964 | 2085 | </tr> |
1965 | 2086 |
|
1966 | 2087 | </table> |
|
0 commit comments