@coveo/push-api-client 2.8.1 → 2.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
  2. package/dist/docs/classes/CatalogSource.html +17 -17
  3. package/dist/docs/classes/DocumentBuilder.html +29 -29
  4. package/dist/docs/classes/FieldAnalyser.html +12 -12
  5. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
  6. package/dist/docs/classes/PushSource.html +24 -24
  7. package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
  8. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
  9. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
  10. package/dist/docs/classes/errors.InvalidDocument.html +3 -3
  11. package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
  12. package/dist/docs/classes/errors.NotAFileError.html +3 -3
  13. package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
  14. package/dist/docs/classes/errors.PrivilegeError.html +4 -4
  15. package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
  16. package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
  17. package/dist/docs/enums/PlatformEnvironment.html +5 -5
  18. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
  19. package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
  20. package/dist/docs/interfaces/Document.html +14 -14
  21. package/dist/docs/interfaces/SecurityIdentity.html +4 -4
  22. package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
  23. package/dist/docs/interfaces/UploadBatchCallbackData.html +5 -5
  24. package/dist/docs/modules/errors.html +1 -1
  25. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  26. package/dist/docs/types/CompressionType.html +1 -1
  27. package/dist/docs/types/FailedUploadCallback.html +1 -1
  28. package/dist/docs/types/Metadata.html +1 -1
  29. package/dist/docs/types/MetadataValue.html +1 -1
  30. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  31. package/dist/docs/types/SecurityIdentityType.html +1 -1
  32. package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
  33. package/dist/docs/types/Transformer.html +1 -1
  34. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  35. package/dist/docs/variables/Source.html +1 -1
  36. package/package.json +2 -2
package/dist/docs/classes/errors.UnsupportedAttribute.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">UnsupportedAttribute</span></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/validatorErrors.ts#L31">src/errors/validatorErrors.ts:31</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/errors/validatorErrors.ts#L31">src/errors/validatorErrors.ts:31</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -62,7 +62,7 @@
62
62
  <h4 class="tsd-returns-title">Returns <a href="errors.UnsupportedAttribute.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedAttribute</a></h4><aside class="tsd-sources">
63
63
  <p>Overrides PushApiClientBaseError.constructor</p>
64
64
  <ul>
65
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/validatorErrors.ts#L33">src/errors/validatorErrors.ts:33</a></li></ul></aside></li></ul></section></section>
65
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/errors/validatorErrors.ts#L33">src/errors/validatorErrors.ts:33</a></li></ul></aside></li></ul></section></section>
66
66
  <section class="tsd-panel-group tsd-member-group">
67
67
  <h2>Properties</h2>
68
68
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
@@ -76,7 +76,7 @@
76
76
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Unsupported Attribute Error&#39;</span></div><aside class="tsd-sources">
77
77
  <p>Overrides PushApiClientBaseError.name</p>
78
78
  <ul>
79
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/validatorErrors.ts#L32">src/errors/validatorErrors.ts:32</a></li></ul></aside></section>
79
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/errors/validatorErrors.ts#L32">src/errors/validatorErrors.ts:32</a></li></ul></aside></section>
80
80
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
81
81
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
82
82
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
package/dist/docs/classes/errors.UnsupportedFieldError.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">UnsupportedFieldError</span></li></ul></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/fieldErrors.ts#L40">src/errors/fieldErrors.ts:40</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/errors/fieldErrors.ts#L40">src/errors/fieldErrors.ts:40</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -66,7 +66,7 @@
66
66
  <h4 class="tsd-returns-title">Returns <a href="errors.UnsupportedFieldError.html" class="tsd-signature-type" data-tsd-kind="Class">UnsupportedFieldError</a></h4><aside class="tsd-sources">
67
67
  <p>Overrides PushApiClientBaseError.constructor</p>
68
68
  <ul>
69
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/fieldErrors.ts#L44">src/errors/fieldErrors.ts:44</a></li></ul></aside></li></ul></section></section>
69
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/errors/fieldErrors.ts#L44">src/errors/fieldErrors.ts:44</a></li></ul></aside></li></ul></section></section>
70
70
  <section class="tsd-panel-group tsd-member-group">
71
71
  <h2>Properties</h2>
72
72
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
@@ -80,7 +80,7 @@
80
80
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Unsupported field Error&#39;</span></div><aside class="tsd-sources">
81
81
  <p>Overrides PushApiClientBaseError.name</p>
82
82
  <ul>
83
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
83
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/errors/fieldErrors.ts#L41">src/errors/fieldErrors.ts:41</a></li></ul></aside></section>
84
84
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
85
85
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
86
86
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -91,12 +91,12 @@
91
91
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>unsupported<wbr/>Fields</span><a href="#unsupportedFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
92
92
  <div class="tsd-signature">unsupported<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
93
93
  <ul>
94
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
94
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/errors/fieldErrors.ts#L43">src/errors/fieldErrors.ts:43</a></li></ul></aside></section>
95
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="emptyFieldNameReplacer" class="tsd-anchor"></a>
96
96
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>empty<wbr/>Field<wbr/>Name<wbr/>Replacer</span><a href="#emptyFieldNameReplacer" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
97
97
  <div class="tsd-signature">empty<wbr/>Field<wbr/>Name<wbr/>Replacer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&lt;empty field name&gt;&#39;</span></div><aside class="tsd-sources">
98
98
  <ul>
99
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
99
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/errors/fieldErrors.ts#L42">src/errors/fieldErrors.ts:42</a></li></ul></aside></section>
100
100
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
101
101
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
102
102
  <div class="tsd-signature">prepare<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
@@ -137,7 +137,7 @@
137
137
  <li class="tsd-description">
138
138
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
139
139
  <ul>
140
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/fieldErrors.ts#L54">src/errors/fieldErrors.ts:54</a></li></ul></aside></li></ul></section></section>
140
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/errors/fieldErrors.ts#L54">src/errors/fieldErrors.ts:54</a></li></ul></aside></li></ul></section></section>
141
141
  <section class="tsd-panel-group tsd-member-group">
142
142
  <h2>Methods</h2>
143
143
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
package/dist/docs/enums/PlatformEnvironment.html CHANGED
@@ -16,7 +16,7 @@
16
16
  <li><a href="PlatformEnvironment.html">PlatformEnvironment</a></li></ul>
17
17
  <h1>Enumeration PlatformEnvironment</h1></div><aside class="tsd-sources">
18
18
  <ul>
19
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/environment.ts#L4">src/environment.ts:4</a></li></ul></aside>
19
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/environment.ts#L4">src/environment.ts:4</a></li></ul></aside>
20
20
  <section class="tsd-panel-group tsd-index-group">
21
21
  <section class="tsd-panel tsd-index-panel">
22
22
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -35,22 +35,22 @@
35
35
  <h3 class="tsd-anchor-link"><span>Dev</span><a href="#Dev" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
36
36
  <div class="tsd-signature">Dev<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dev&quot;</span></div><aside class="tsd-sources">
37
37
  <ul>
38
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
38
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/environment.ts#L5">src/environment.ts:5</a></li></ul></aside></section>
39
39
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Hipaa" class="tsd-anchor"></a>
40
40
  <h3 class="tsd-anchor-link"><span>Hipaa</span><a href="#Hipaa" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
41
41
  <div class="tsd-signature">Hipaa<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;hipaa&quot;</span></div><aside class="tsd-sources">
42
42
  <ul>
43
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
43
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/environment.ts#L7">src/environment.ts:7</a></li></ul></aside></section>
44
44
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Prod" class="tsd-anchor"></a>
45
45
  <h3 class="tsd-anchor-link"><span>Prod</span><a href="#Prod" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
46
46
  <div class="tsd-signature">Prod<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;prod&quot;</span></div><aside class="tsd-sources">
47
47
  <ul>
48
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
48
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/environment.ts#L8">src/environment.ts:8</a></li></ul></aside></section>
49
49
  <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Stg" class="tsd-anchor"></a>
50
50
  <h3 class="tsd-anchor-link"><span>Stg</span><a href="#Stg" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
51
51
  <div class="tsd-signature">Stg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stg&quot;</span></div><aside class="tsd-sources">
52
52
  <ul>
53
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
53
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/environment.ts#L6">src/environment.ts:6</a></li></ul></aside></section></section></div>
54
54
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
55
55
  <div class="tsd-navigation settings">
56
56
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html CHANGED
@@ -28,7 +28,7 @@
28
28
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ParseDocumentOptions</span></h5></li></ul></div>
29
29
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
30
30
  <ul>
31
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
31
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/validation/parseFile.ts#L27">src/validation/parseFile.ts:27</a></li></ul></aside></li></ul></section></div>
32
32
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
33
33
  <div class="tsd-navigation settings">
34
34
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/BatchUpdateDocuments.html CHANGED
@@ -20,7 +20,7 @@
20
20
  <ul class="tsd-hierarchy">
21
21
  <li><span class="target">BatchUpdateDocuments</span></li></ul></section><aside class="tsd-sources">
22
22
  <ul>
23
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
23
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/interfaces.ts#L9">src/interfaces.ts:9</a></li></ul></aside>
24
24
  <section class="tsd-panel-group tsd-index-group">
25
25
  <section class="tsd-panel tsd-index-panel">
26
26
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -37,12 +37,12 @@
37
37
  <h3 class="tsd-anchor-link"><span>add<wbr/>Or<wbr/>Update</span><a href="#addOrUpdate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
38
38
  <div class="tsd-signature">add<wbr/>Or<wbr/>Update<span class="tsd-signature-symbol">:</span> <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
39
39
  <ul>
40
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
40
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/interfaces.ts#L10">src/interfaces.ts:10</a></li></ul></aside></section>
41
41
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="delete" class="tsd-anchor"></a>
42
42
  <h3 class="tsd-anchor-link"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
43
43
  <div class="tsd-signature">delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>deleteChildren<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
44
44
  <ul>
45
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
45
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/interfaces.ts#L11">src/interfaces.ts:11</a></li></ul></aside></section></section></div>
46
46
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
47
47
  <div class="tsd-navigation settings">
48
48
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/Document.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">Document</span></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L54">src/document.ts:54</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L54">src/document.ts:54</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -53,14 +53,14 @@
53
53
  <div class="tsd-comment tsd-typography"><p>The author of the document.</p>
54
54
  </div><aside class="tsd-sources">
55
55
  <ul>
56
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L74">src/document.ts:74</a></li></ul></aside></section>
56
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L74">src/document.ts:74</a></li></ul></aside></section>
57
57
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="clickableUri" class="tsd-anchor"></a>
58
58
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>clickable<wbr/>Uri</span><a href="#clickableUri" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
59
59
  <div class="tsd-signature">clickable<wbr/>Uri<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
60
60
  <div class="tsd-comment tsd-typography"><p>The clickable URI associated with the document.</p>
61
61
  </div><aside class="tsd-sources">
62
62
  <ul>
63
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L70">src/document.ts:70</a></li></ul></aside></section>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L70">src/document.ts:70</a></li></ul></aside></section>
64
64
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="compressedBinaryData" class="tsd-anchor"></a>
65
65
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>compressed<wbr/>Binary<wbr/>Data</span><a href="#compressedBinaryData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
66
66
  <div class="tsd-signature">compressed<wbr/>Binary<wbr/>Data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -83,7 +83,7 @@
83
83
  <p>Example: <code>eJxzrUjMLchJBQAK4ALN</code></p>
84
84
  </div></li></ul></div><aside class="tsd-sources">
85
85
  <ul>
86
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L124">src/document.ts:124</a></li></ul></aside></section>
86
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L124">src/document.ts:124</a></li></ul></aside></section>
87
87
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="data-1" class="tsd-anchor"></a>
88
88
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>data</span><a href="#data-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
89
89
  <div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -94,7 +94,7 @@
94
94
  <p>Example: <code>This is a simple string that will be used for searchability as well as to generate excerpt and summaries for the document.</code></p>
95
95
  </div><aside class="tsd-sources">
96
96
  <ul>
97
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L112">src/document.ts:112</a></li></ul></aside></section>
97
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L112">src/document.ts:112</a></li></ul></aside></section>
98
98
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="date" class="tsd-anchor"></a>
99
99
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>date</span><a href="#date" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
100
100
  <div class="tsd-signature">date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -102,7 +102,7 @@
102
102
  <p>Optional, will default to indexation date.</p>
103
103
  </div><aside class="tsd-sources">
104
104
  <ul>
105
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L80">src/document.ts:80</a></li></ul></aside></section>
105
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L80">src/document.ts:80</a></li></ul></aside></section>
106
106
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="fileExtension" class="tsd-anchor"></a>
107
107
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>file<wbr/>Extension</span><a href="#fileExtension" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
108
108
  <div class="tsd-signature">file<wbr/>Extension<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -112,7 +112,7 @@
112
112
  <p>Example: <code>.html</code></p>
113
113
  </div><aside class="tsd-sources">
114
114
  <ul>
115
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L178">src/document.ts:178</a></li></ul></aside></section>
115
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L178">src/document.ts:178</a></li></ul></aside></section>
116
116
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="metadata" class="tsd-anchor"></a>
117
117
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>metadata</span><a href="#metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
118
118
  <div class="tsd-signature">metadata<span class="tsd-signature-symbol">?:</span> <a href="../types/Metadata.html" class="tsd-signature-type" data-tsd-kind="Type alias">Metadata</a></div>
@@ -122,7 +122,7 @@
122
122
  <p>See <a href="https://docs.coveo.com/en/115">https://docs.coveo.com/en/115</a> for more information.</p>
123
123
  </div><aside class="tsd-sources">
124
124
  <ul>
125
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L145">src/document.ts:145</a></li></ul></aside></section>
125
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L145">src/document.ts:145</a></li></ul></aside></section>
126
126
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="modifiedDate" class="tsd-anchor"></a>
127
127
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>modified<wbr/>Date</span><a href="#modifiedDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
128
128
  <div class="tsd-signature">modified<wbr/>Date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -130,7 +130,7 @@
130
130
  <p>Optional, will default to indexation date.</p>
131
131
  </div><aside class="tsd-sources">
132
132
  <ul>
133
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L86">src/document.ts:86</a></li></ul></aside></section>
133
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L86">src/document.ts:86</a></li></ul></aside></section>
134
134
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="parentId" class="tsd-anchor"></a>
135
135
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>parent<wbr/>Id</span><a href="#parentId" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
136
136
  <div class="tsd-signature">parent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -139,7 +139,7 @@
139
139
  <p>This value also ensures that a parent and all of its attachments will be routed in the same index slice.</p>
140
140
  </div><aside class="tsd-sources">
141
141
  <ul>
142
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L100">src/document.ts:100</a></li></ul></aside></section>
142
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L100">src/document.ts:100</a></li></ul></aside></section>
143
143
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permanentId" class="tsd-anchor"></a>
144
144
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>permanent<wbr/>Id</span><a href="#permanentId" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
145
145
  <div class="tsd-signature">permanent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -147,7 +147,7 @@
147
147
  <p>Optional, will be derived from the document URI.</p>
148
148
  </div><aside class="tsd-sources">
149
149
  <ul>
150
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L92">src/document.ts:92</a></li></ul></aside></section>
150
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L92">src/document.ts:92</a></li></ul></aside></section>
151
151
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="permissions" class="tsd-anchor"></a>
152
152
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>permissions</span><a href="#permissions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
153
153
  <div class="tsd-signature">permissions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>allowedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>deniedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -172,14 +172,14 @@
172
172
  <div class="tsd-comment tsd-typography"><p>The list of denied permissions for this permission set.</p>
173
173
  </div></li></ul></div><aside class="tsd-sources">
174
174
  <ul>
175
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L153">src/document.ts:153</a></li></ul></aside></section>
175
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L153">src/document.ts:153</a></li></ul></aside></section>
176
176
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="title" class="tsd-anchor"></a>
177
177
  <h3 class="tsd-anchor-link"><span>title</span><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
178
178
  <div class="tsd-signature">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
179
179
  <div class="tsd-comment tsd-typography"><p>The title of the document.</p>
180
180
  </div><aside class="tsd-sources">
181
181
  <ul>
182
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L66">src/document.ts:66</a></li></ul></aside></section>
182
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L66">src/document.ts:66</a></li></ul></aside></section>
183
183
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="uri" class="tsd-anchor"></a>
184
184
  <h3 class="tsd-anchor-link"><span>uri</span><a href="#uri" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
185
185
  <div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -191,7 +191,7 @@
191
191
  </ul>
192
192
  </div><aside class="tsd-sources">
193
193
  <ul>
194
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L62">src/document.ts:62</a></li></ul></aside></section></section></div>
194
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L62">src/document.ts:62</a></li></ul></aside></section></section></div>
195
195
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
196
196
  <div class="tsd-navigation settings">
197
197
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/SecurityIdentity.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <ul class="tsd-hierarchy">
24
24
  <li><span class="target">SecurityIdentity</span></li></ul></section><aside class="tsd-sources">
25
25
  <ul>
26
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L10">src/document.ts:10</a></li></ul></aside>
26
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L10">src/document.ts:10</a></li></ul></aside>
27
27
  <section class="tsd-panel-group tsd-index-group">
28
28
  <section class="tsd-panel tsd-index-panel">
29
29
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -48,7 +48,7 @@
48
48
  </ul>
49
49
  </div><aside class="tsd-sources">
50
50
  <ul>
51
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L18">src/document.ts:18</a></li></ul></aside></section>
51
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L18">src/document.ts:18</a></li></ul></aside></section>
52
52
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="identityType" class="tsd-anchor"></a>
53
53
  <h3 class="tsd-anchor-link"><span>identity<wbr/>Type</span><a href="#identityType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
54
54
  <div class="tsd-signature">identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../types/SecurityIdentityType.html" class="tsd-signature-type" data-tsd-kind="Type alias">SecurityIdentityType</a></div>
@@ -62,7 +62,7 @@ Valid values:</p>
62
62
  </ul>
63
63
  </div><aside class="tsd-sources">
64
64
  <ul>
65
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L27">src/document.ts:27</a></li></ul></aside></section>
65
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L27">src/document.ts:27</a></li></ul></aside></section>
66
66
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="securityProvider" class="tsd-anchor"></a>
67
67
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>security<wbr/>Provider</span><a href="#securityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
68
68
  <div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -70,7 +70,7 @@ Valid values:</p>
70
70
  <p>Defaults to the first security identity provider associated with the target Push source.</p>
71
71
  </div><aside class="tsd-sources">
72
72
  <ul>
73
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L33">src/document.ts:33</a></li></ul></aside></section></section></div>
73
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L33">src/document.ts:33</a></li></ul></aside></section></section></div>
74
74
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
75
75
  <div class="tsd-navigation settings">
76
76
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/SecurityIdentityBuilder.html CHANGED
@@ -30,7 +30,7 @@
30
30
  <li><a href="../classes/UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></li>
31
31
  <li><a href="../classes/VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
32
32
  <ul>
33
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L6">src/securityIdentityBuilder.ts:6</a></li></ul></aside>
33
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/securityIdentityBuilder.ts#L6">src/securityIdentityBuilder.ts:6</a></li></ul></aside>
34
34
  <section class="tsd-panel-group tsd-index-group">
35
35
  <section class="tsd-panel tsd-index-panel">
36
36
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -49,7 +49,7 @@
49
49
  <li class="tsd-description">
50
50
  <h4 class="tsd-returns-title">Returns <a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
51
51
  <ul>
52
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/securityIdentityBuilder.ts#L7">src/securityIdentityBuilder.ts:7</a></li></ul></aside></li></ul></section></section></div>
52
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/securityIdentityBuilder.ts#L7">src/securityIdentityBuilder.ts:7</a></li></ul></aside></li></ul></section></section></div>
53
53
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
54
54
  <div class="tsd-navigation settings">
55
55
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/interfaces/UploadBatchCallbackData.html CHANGED
@@ -30,7 +30,7 @@
30
30
  <ul class="tsd-hierarchy">
31
31
  <li><span class="target">UploadBatchCallbackData</span></li></ul></section><aside class="tsd-sources">
32
32
  <ul>
33
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/interfaces.ts#L30">src/interfaces.ts:30</a></li></ul></aside>
33
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/interfaces.ts#L30">src/interfaces.ts:30</a></li></ul></aside>
34
34
  <section class="tsd-panel-group tsd-index-group">
35
35
  <section class="tsd-panel tsd-index-panel">
36
36
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -49,22 +49,22 @@
49
49
  <h3 class="tsd-anchor-link"><span>batch</span><a href="#batch" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
50
50
  <div class="tsd-signature">batch<span class="tsd-signature-symbol">:</span> <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
51
51
  <ul>
52
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/interfaces.ts#L32">src/interfaces.ts:32</a></li></ul></aside></section>
52
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/interfaces.ts#L32">src/interfaces.ts:32</a></li></ul></aside></section>
53
53
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="files" class="tsd-anchor"></a>
54
54
  <h3 class="tsd-anchor-link"><span>files</span><a href="#files" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
55
55
  <div class="tsd-signature">files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
56
56
  <ul>
57
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/interfaces.ts#L31">src/interfaces.ts:31</a></li></ul></aside></section>
57
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/interfaces.ts#L31">src/interfaces.ts:31</a></li></ul></aside></section>
58
58
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="progress" class="tsd-anchor"></a>
59
59
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>progress</span><a href="#progress" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
60
60
  <div class="tsd-signature">progress<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">UploadProgress</span></div><aside class="tsd-sources">
61
61
  <ul>
62
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/interfaces.ts#L33">src/interfaces.ts:33</a></li></ul></aside></section>
62
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/interfaces.ts#L33">src/interfaces.ts:33</a></li></ul></aside></section>
63
63
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="res" class="tsd-anchor"></a>
64
64
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>res</span><a href="#res" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
65
65
  <div class="tsd-signature">res<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
66
66
  <ul>
67
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/interfaces.ts#L34">src/interfaces.ts:34</a></li></ul></aside></section></section></div>
67
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/interfaces.ts#L34">src/interfaces.ts:34</a></li></ul></aside></section></section></div>
68
68
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
69
69
  <div class="tsd-navigation settings">
70
70
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/modules/errors.html CHANGED
@@ -16,7 +16,7 @@
16
16
  <li><a href="errors.html">errors</a></li></ul>
17
17
  <h1>Namespace errors</h1></div><aside class="tsd-sources">
18
18
  <ul>
19
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/errors/index.ts#L1">src/errors/index.ts:1</a></li></ul></aside>
19
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/errors/index.ts#L1">src/errors/index.ts:1</a></li></ul></aside>
20
20
  <section class="tsd-panel-group tsd-index-group">
21
21
  <section class="tsd-panel tsd-index-panel">
22
22
  <h3 class="tsd-index-heading uppercase">Index</h3>
package/dist/docs/types/BatchUpdateDocumentsFromFiles.html CHANGED
@@ -17,7 +17,7 @@
17
17
  <h1>Type alias BatchUpdateDocumentsFromFiles</h1></div>
18
18
  <div class="tsd-signature">Batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ConcurrentProcessing</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ParseDocumentOptions</span></div><aside class="tsd-sources">
19
19
  <ul>
20
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/interfaces.ts#L75">src/interfaces.ts:75</a></li></ul></aside></div>
20
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/interfaces.ts#L75">src/interfaces.ts:75</a></li></ul></aside></div>
21
21
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
22
22
  <div class="tsd-navigation settings">
23
23
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/CompressionType.html CHANGED
@@ -19,7 +19,7 @@
19
19
  <div class="tsd-comment tsd-typography"><p>The compression type that was applied to your compressed document.</p>
20
20
  </div><aside class="tsd-sources">
21
21
  <ul>
22
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L44">src/document.ts:44</a></li></ul></aside></div>
22
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L44">src/document.ts:44</a></li></ul></aside></div>
23
23
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
24
24
  <div class="tsd-navigation settings">
25
25
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/FailedUploadCallback.html CHANGED
@@ -32,7 +32,7 @@
32
32
  <h5>value: <a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a></h5></li></ul></div>
33
33
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
34
34
  <ul>
35
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/help/fileConsumer.ts#L16">src/help/fileConsumer.ts:16</a></li></ul></aside></div>
35
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/help/fileConsumer.ts#L16">src/help/fileConsumer.ts:16</a></li></ul></aside></div>
36
36
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
37
37
  <div class="tsd-navigation settings">
38
38
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/Metadata.html CHANGED
@@ -17,7 +17,7 @@
17
17
  <h1>Type alias Metadata</h1></div>
18
18
  <div class="tsd-signature">Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
19
19
  <ul>
20
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L39">src/document.ts:39</a></li></ul></aside></div>
20
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L39">src/document.ts:39</a></li></ul></aside></div>
21
21
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
22
22
  <div class="tsd-navigation settings">
23
23
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/MetadataValue.html CHANGED
@@ -17,7 +17,7 @@
17
17
  <h1>Type alias MetadataValue</h1></div>
18
18
  <div class="tsd-signature">Metadata<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BaseMetadataValue</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DictionaryMetadataValue</span></div><aside class="tsd-sources">
19
19
  <ul>
20
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L38">src/document.ts:38</a></li></ul></aside></div>
20
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L38">src/document.ts:38</a></li></ul></aside></div>
21
21
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
22
22
  <div class="tsd-navigation settings">
23
23
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/PlatformUrlOptions.html CHANGED
@@ -24,7 +24,7 @@
24
24
  <li class="tsd-parameter">
25
25
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> region<span class="tsd-signature-symbol">?: </span><a href="../enums/Region.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Region</a></h5></li></ul></div><aside class="tsd-sources">
26
26
  <ul>
27
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/environment.ts#L14">src/environment.ts:14</a></li></ul></aside></div>
27
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/environment.ts#L14">src/environment.ts:14</a></li></ul></aside></div>
28
28
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
29
29
  <div class="tsd-navigation settings">
30
30
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/SecurityIdentityType.html CHANGED
@@ -17,7 +17,7 @@
17
17
  <h1>Type alias SecurityIdentityType</h1></div>
18
18
  <div class="tsd-signature">Security<wbr/>Identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;UNKNOWN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;USER&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;GROUP&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;VIRTUAL_GROUP&quot;</span></div><aside class="tsd-sources">
19
19
  <ul>
20
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/document.ts#L1">src/document.ts:1</a></li></ul></aside></div>
20
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/document.ts#L1">src/document.ts:1</a></li></ul></aside></div>
21
21
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
22
22
  <div class="tsd-navigation settings">
23
23
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/SuccessfulUploadCallback.html CHANGED
@@ -30,7 +30,7 @@
30
30
  <h5>data: <a href="../interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a></h5></li></ul></div>
31
31
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
32
32
  <ul>
33
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/help/fileConsumer.ts#L15">src/help/fileConsumer.ts:15</a></li></ul></aside></div>
33
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/help/fileConsumer.ts#L15">src/help/fileConsumer.ts:15</a></li></ul></aside></div>
34
34
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
35
35
  <div class="tsd-navigation settings">
36
36
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/types/Transformer.html CHANGED
@@ -30,7 +30,7 @@
30
30
  <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
31
31
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
32
32
  <ul>
33
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/27ba71c/src/validation/transformers/transformer.ts#L1">src/validation/transformers/transformer.ts:1</a></li></ul></aside></div>
33
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/dc03c72/src/validation/transformers/transformer.ts#L1">src/validation/transformers/transformer.ts:1</a></li></ul></aside></div>
34
34
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
35
35
  <div class="tsd-navigation settings">
36
36
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">