Skip to content

Commit a005bdc

Browse files
author
Ruslan Tereshchenko
committed
update docs
1 parent 46c4dbc commit a005bdc

File tree

9 files changed

+20689
-6296
lines changed

9 files changed

+20689
-6296
lines changed

‎docs/ast/source/documentGroup.js.json

+20,208-6,121
Large diffs are not rendered by default.

‎docs/badge.svg

+2-2
Loading

‎docs/class/lib/documentGroup.js~DocumentGroup.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -126,13 +126,13 @@
126126
</nav>
127127

128128
<div class="content" data-ice="content"><div class="header-notice">
129-
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import DocumentGroup from &apos;<span><a href="file/lib/documentGroup.js.html#lineNumber12">@signnow/api-client/lib/documentGroup.js</a></span>&apos;</code></pre></div>
129+
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import DocumentGroup from &apos;<span><a href="file/lib/documentGroup.js.html#lineNumber90">@signnow/api-client/lib/documentGroup.js</a></span>&apos;</code></pre></div>
130130
<span data-ice="access">public</span>
131131
<span data-ice="kind">class</span>
132132

133133

134134

135-
<span data-ice="source">| <span><a href="file/lib/documentGroup.js.html#lineNumber12">source</a></span></span>
135+
<span data-ice="source">| <span><a href="file/lib/documentGroup.js.html#lineNumber90">source</a></span></span>
136136
</div>
137137

138138
<div class="self-detail detail">
@@ -252,7 +252,7 @@ <h3 data-ice="anchor" id="static-method-create">
252252
<span class="right-info">
253253

254254

255-
<span data-ice="source"><span><a href="file/lib/documentGroup.js.html#lineNumber33">source</a></span></span>
255+
<span data-ice="source"><span><a href="file/lib/documentGroup.js.html#lineNumber112">source</a></span></span>
256256
</span>
257257
</h3>
258258

@@ -321,7 +321,7 @@ <h3 data-ice="anchor" id="static-method-invite">
321321
<span class="right-info">
322322

323323

324-
<span data-ice="source"><span><a href="file/lib/documentGroup.js.html#lineNumber149">source</a></span></span>
324+
<span data-ice="source"><span><a href="file/lib/documentGroup.js.html#lineNumber256">source</a></span></span>
325325
</span>
326326
</h3>
327327

‎docs/coverage.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"coverage": "85.36%",
3-
"expectCount": 41,
4-
"actualCount": 35,
2+
"coverage": "87.5%",
3+
"expectCount": 48,
4+
"actualCount": 42,
55
"files": {
66
"lib/document.js": {
77
"expectCount": 17,
@@ -16,8 +16,8 @@
1616
]
1717
},
1818
"lib/documentGroup.js": {
19-
"expectCount": 3,
20-
"actualCount": 3,
19+
"expectCount": 10,
20+
"actualCount": 10,
2121
"undocumentLines": []
2222
},
2323
"lib/documentGroupTemplate.js": {

‎docs/file/lib/documentGroup.js.html

+4-12
Original file line numberDiff line numberDiff line change
@@ -242,21 +242,13 @@
242242
ids,
243243
group_name,
244244
}, callback) {
245-
const JSONData = JSON.stringify({
246-
document_ids,
247-
group_name,
248-
});
249-
250-
const req = https
251-
.request(buildRequestOptions({
252-
method: &apos;POST&apos;,
253-
path: &apos;/documentgroup&apos;,
254-
authorization: {
255-
type: &apos;Bearer&apos;,
245+
const realDocumentIDs = ids
246+
.map(id =&gt; {
247+
return getDocumentDetails({
248+
id,
256249
token,
257250
})
258251
.then(document =&gt; {
259-
260252
if (isTemplate(document)) {
261253
return makeDocumentFromTemplate({
262254
id,

‎docs/index.html

+4-5
Original file line numberDiff line numberDiff line change
@@ -604,11 +604,10 @@ <h3 id="-a-name--document-group----a-document-group"><a name="document-group"></
604604
token: &apos;your auth token&apos;,
605605
group_name: &apos;my document group name&apos;,
606606
ids: [
607-
// put document or template IDs here
608-
&apos;84a18d12bf7473ea3dd0e4dd1cdcded6ba6281aa&apos;,
609-
&apos;a71d963c49f33176e90c5827069c422616b1500c&apos;,
610-
],
611-
group_name: &apos;my document group name&apos;,
607+
// put document or template IDs here
608+
&apos;84a18d12bf7473ea3dd0e4dd1cdcded6ba6281aa&apos;,
609+
&apos;a71d963c49f33176e90c5827069c422616b1500c&apos;,
610+
],
612611
}, (err, res) =&gt; {
613612
// handle error or process response data
614613
});</code>

‎docs/index.json

+449-134
Large diffs are not rendered by default.

‎docs/source.html

+11-11
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@
125125
</div>
126126
</nav>
127127

128-
<div class="content" data-ice="content"><h1>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">35/41</span></h1>
128+
<div class="content" data-ice="content"><h1>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">42/48</span></h1>
129129

130130
<table class="files-summary" data-ice="files" data-use-coverage="true">
131131
<thead>
@@ -146,55 +146,55 @@
146146
<td class="coverage"><span data-ice="coverage">64 %</span><span data-ice="coverageCount" class="coverage-count">11/17</span></td>
147147
<td style="display: none;" data-ice="size">31966 byte</td>
148148
<td style="display: none;" data-ice="lines">883</td>
149-
<td style="display: none;" data-ice="updated">2019-08-04 08:36:29 (UTC)</td>
149+
<td style="display: none;" data-ice="updated">2019-08-04 09:15:55 (UTC)</td>
150150
</tr>
151151
<tr data-ice="file">
152152
<td data-ice="filePath"><span><a href="file/lib/documentGroup.js.html">lib/documentGroup.js</a></span></td>
153153
<td data-ice="identifier" class="identifiers"><span><a href="class/lib/documentGroup.js~DocumentGroup.html">DocumentGroup</a></span></td>
154-
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">3/3</span></td>
155-
<td style="display: none;" data-ice="size">6317 byte</td>
156-
<td style="display: none;" data-ice="lines">186</td>
157-
<td style="display: none;" data-ice="updated">2019-08-04 08:36:29 (UTC)</td>
154+
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">10/10</span></td>
155+
<td style="display: none;" data-ice="size">9248 byte</td>
156+
<td style="display: none;" data-ice="lines">292</td>
157+
<td style="display: none;" data-ice="updated">2019-08-04 09:27:59 (UTC)</td>
158158
</tr>
159159
<tr data-ice="file">
160160
<td data-ice="filePath"><span><a href="file/lib/documentGroupTemplate.js.html">lib/documentGroupTemplate.js</a></span></td>
161161
<td data-ice="identifier" class="identifiers"><span><a href="class/lib/documentGroupTemplate.js~DocumentGroupTemplate.html">DocumentGroupTemplate</a></span></td>
162162
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">2/2</span></td>
163163
<td style="display: none;" data-ice="size">3923 byte</td>
164164
<td style="display: none;" data-ice="lines">105</td>
165-
<td style="display: none;" data-ice="updated">2019-08-04 08:36:29 (UTC)</td>
165+
<td style="display: none;" data-ice="updated">2019-08-04 09:15:55 (UTC)</td>
166166
</tr>
167167
<tr data-ice="file">
168168
<td data-ice="filePath"><span><a href="file/lib/index.js.html">lib/index.js</a></span></td>
169169
<td data-ice="identifier" class="identifiers"><span><a href="function/index.html#static-function-init">init</a></span></td>
170170
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">1/1</span></td>
171171
<td style="display: none;" data-ice="size">2012 byte</td>
172172
<td style="display: none;" data-ice="lines">76</td>
173-
<td style="display: none;" data-ice="updated">2019-08-04 08:36:29 (UTC)</td>
173+
<td style="display: none;" data-ice="updated">2019-08-04 09:15:55 (UTC)</td>
174174
</tr>
175175
<tr data-ice="file">
176176
<td data-ice="filePath"><span><a href="file/lib/link.js.html">lib/link.js</a></span></td>
177177
<td data-ice="identifier" class="identifiers"><span><a href="class/lib/link.js~Link.html">Link</a></span></td>
178178
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">3/3</span></td>
179179
<td style="display: none;" data-ice="size">2510 byte</td>
180180
<td style="display: none;" data-ice="lines">82</td>
181-
<td style="display: none;" data-ice="updated">2019-08-04 08:36:29 (UTC)</td>
181+
<td style="display: none;" data-ice="updated">2019-08-04 09:15:55 (UTC)</td>
182182
</tr>
183183
<tr data-ice="file">
184184
<td data-ice="filePath"><span><a href="file/lib/oauth2.js.html">lib/oauth2.js</a></span></td>
185185
<td data-ice="identifier" class="identifiers"><span><a href="class/lib/oauth2.js~OAuth2.html">OAuth2</a></span></td>
186186
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">4/4</span></td>
187187
<td style="display: none;" data-ice="size">4457 byte</td>
188188
<td style="display: none;" data-ice="lines">132</td>
189-
<td style="display: none;" data-ice="updated">2019-08-04 08:36:29 (UTC)</td>
189+
<td style="display: none;" data-ice="updated">2019-08-04 09:15:55 (UTC)</td>
190190
</tr>
191191
<tr data-ice="file">
192192
<td data-ice="filePath"><span><a href="file/lib/template.js.html">lib/template.js</a></span></td>
193193
<td data-ice="identifier" class="identifiers"><span><a href="class/lib/template.js~Template.html">Template</a></span></td>
194194
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">8/8</span></td>
195195
<td style="display: none;" data-ice="size">7512 byte</td>
196196
<td style="display: none;" data-ice="lines">268</td>
197-
<td style="display: none;" data-ice="updated">2019-08-04 08:36:29 (UTC)</td>
197+
<td style="display: none;" data-ice="updated">2019-08-04 09:15:55 (UTC)</td>
198198
</tr>
199199
<tr data-ice="file">
200200
<td data-ice="filePath"><span><a href="file/lib/user.js.html">lib/user.js</a></span></td>

‎docs/typedef/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -4311,10 +4311,10 @@ <h4 data-ice="title">Properties:</h4>
43114311
</td>
43124312
</tr>
43134313
<tr data-ice="property" data-depth="0">
4314-
<td data-ice="name" class="code" data-depth="0">document_ids</td>
4314+
<td data-ice="name" class="code" data-depth="0">ids</td>
43154315
<td data-ice="type" class="code"><span><span>string</span><span>[]</span></span></td>
43164316
<td data-ice="appendix"></td>
4317-
<td data-ice="description"><p>array of document ids for document group creation</p>
4317+
<td data-ice="description"><p>array of document or template ids for document group creation</p>
43184318
</td>
43194319
</tr>
43204320
<tr data-ice="property" data-depth="0">

0 commit comments

Comments
 (0)