@coveo/push-api-client 2.4.18 → 2.4.26

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 (47) hide show
  1. package/dist/docs/assets/highlight.css +49 -0
  2. package/dist/docs/assets/main.js +3 -3
  3. package/dist/docs/assets/search.js +1 -1
  4. package/dist/docs/assets/style.css +6 -82
  5. package/dist/docs/classes/AnySecurityIdentityBuilder.html +15 -11
  6. package/dist/docs/classes/CatalogSource.html +67 -55
  7. package/dist/docs/classes/DocumentBuilder.html +139 -112
  8. package/dist/docs/classes/FieldAnalyser.html +59 -50
  9. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +11 -7
  10. package/dist/docs/classes/PushSource.html +96 -76
  11. package/dist/docs/classes/UserSecurityIdentityBuilder.html +11 -7
  12. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +11 -7
  13. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +13 -10
  14. package/dist/docs/classes/errors.InvalidDocument.html +13 -10
  15. package/dist/docs/classes/errors.InvalidPermanentId.html +13 -10
  16. package/dist/docs/classes/errors.NotAFileError.html +13 -10
  17. package/dist/docs/classes/errors.NotAJsonFileError.html +13 -10
  18. package/dist/docs/classes/errors.PrivilegeError.html +14 -11
  19. package/dist/docs/classes/errors.UnsupportedAttribute.html +13 -10
  20. package/dist/docs/classes/errors.UnsupportedFieldError.html +23 -19
  21. package/dist/docs/enums/PlatformEnvironment.html +7 -5
  22. package/dist/docs/enums/Region.html +3 -1
  23. package/dist/docs/enums/SourceVisibility.html +3 -1
  24. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +4 -3
  25. package/dist/docs/index.html +49 -2
  26. package/dist/docs/interfaces/BatchUpdateDocuments.html +5 -3
  27. package/dist/docs/interfaces/Document.html +16 -14
  28. package/dist/docs/interfaces/SecurityIdentity.html +6 -4
  29. package/dist/docs/interfaces/SecurityIdentityBuilder.html +7 -4
  30. package/dist/docs/interfaces/UploadBatchCallbackData.html +6 -4
  31. package/dist/docs/modules/errors.html +3 -1
  32. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  33. package/dist/docs/types/CompressionType.html +1 -1
  34. package/dist/docs/types/FailedUploadCallback.html +2 -3
  35. package/dist/docs/types/Metadata.html +1 -1
  36. package/dist/docs/types/MetadataValue.html +1 -1
  37. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  38. package/dist/docs/types/SecurityIdentityType.html +1 -1
  39. package/dist/docs/types/SuccessfulUploadCallback.html +2 -3
  40. package/dist/docs/types/Transformer.html +2 -3
  41. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  42. package/dist/docs/variables/Source.html +1 -1
  43. package/dist/source/catalog.stream.spec.js +13 -0
  44. package/dist/source/catalog.stream.spec.js.map +1 -1
  45. package/dist/source/documentUploader.js +3 -2
  46. package/dist/source/documentUploader.js.map +1 -1
  47. package/package.json +13 -13
package/dist/docs/classes/FieldAnalyser.html CHANGED
@@ -19,7 +19,9 @@
19
19
  <section class="tsd-panel tsd-hierarchy">
20
20
  <h4>Hierarchy</h4>
21
21
  <ul class="tsd-hierarchy">
22
- <li><span class="target">FieldAnalyser</span></li></ul></section>
22
+ <li><span class="target">FieldAnalyser</span></li></ul></section><aside class="tsd-sources">
23
+ <ul>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L20">src/fieldAnalyser/fieldAnalyser.ts:20</a></li></ul></aside>
23
25
  <section class="tsd-panel-group tsd-index-group">
24
26
  <section class="tsd-panel tsd-index-panel">
25
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -31,57 +33,57 @@
31
33
  </div></section>
32
34
  <section class="tsd-index-section">
33
35
  <h3 class="tsd-index-heading">Properties</h3>
34
- <div class="tsd-index-list"><a href="FieldAnalyser.html#existingFields" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>existing<wbr/>Fields</span></a>
35
- <a href="FieldAnalyser.html#inconsistencies" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>inconsistencies</span></a>
36
- <a href="FieldAnalyser.html#missingFields" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>missing<wbr/>Fields</span></a>
36
+ <div class="tsd-index-list"><a href="FieldAnalyser.html#existingFields" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>existing<wbr/>Fields</span></a>
37
+ <a href="FieldAnalyser.html#inconsistencies" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>inconsistencies</span></a>
38
+ <a href="FieldAnalyser.html#missingFields" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>missing<wbr/>Fields</span></a>
37
39
  </div></section>
38
40
  <section class="tsd-index-section">
39
41
  <h3 class="tsd-index-heading">Methods</h3>
40
42
  <div class="tsd-index-list"><a href="FieldAnalyser.html#add" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>add</span></a>
41
- <a href="FieldAnalyser.html#ensureExistingFields" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>ensure<wbr/>Existing<wbr/>Fields</span></a>
42
- <a href="FieldAnalyser.html#ensurePermanentId" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>ensure<wbr/>Permanent<wbr/>Id</span></a>
43
- <a href="FieldAnalyser.html#removeInconsistentFields" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>remove<wbr/>Inconsistent<wbr/>Fields</span></a>
43
+ <a href="FieldAnalyser.html#ensureExistingFields" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>ensure<wbr/>Existing<wbr/>Fields</span></a>
44
+ <a href="FieldAnalyser.html#ensurePermanentId" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>ensure<wbr/>Permanent<wbr/>Id</span></a>
45
+ <a href="FieldAnalyser.html#removeInconsistentFields" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>remove<wbr/>Inconsistent<wbr/>Fields</span></a>
44
46
  <a href="FieldAnalyser.html#report" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>report</span></a>
45
- <a href="FieldAnalyser.html#storeMetadata" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>store<wbr/>Metadata</span></a>
47
+ <a href="FieldAnalyser.html#storeMetadata" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>store<wbr/>Metadata</span></a>
46
48
  </div></section></div></details></section></section>
47
49
  <section class="tsd-panel-group tsd-member-group">
48
50
  <h2>Constructors</h2>
49
51
  <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
50
52
  <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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>
51
53
  <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
52
- <li class="tsd-signature" id="constructor.new_FieldAnalyser">new <wbr/>Field<wbr/>Analyser<span class="tsd-signature-symbol">(</span>platformClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PlatformClient</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></li></ul>
53
- <ul class="tsd-descriptions">
54
+ <li class="tsd-signature tsd-anchor-link" id="constructor.new_FieldAnalyser">new <wbr/>Field<wbr/>Analyser<span class="tsd-signature-symbol">(</span>platformClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PlatformClient</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a><a href="#constructor.new_FieldAnalyser" 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></li>
54
55
  <li class="tsd-description">
55
56
  <div class="tsd-parameters">
56
57
  <h4 class="tsd-parameters-title">Parameters</h4>
57
58
  <ul class="tsd-parameter-list">
58
59
  <li>
59
60
  <h5>platformClient: <span class="tsd-signature-type">PlatformClient</span></h5></li></ul></div>
60
- <h4 class="tsd-returns-title">Returns <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h4></li></ul></section></section>
61
+ <h4 class="tsd-returns-title">Returns <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h4><aside class="tsd-sources">
62
+ <ul>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L25">src/fieldAnalyser/fieldAnalyser.ts:25</a></li></ul></aside></li></ul></section></section>
61
64
  <section class="tsd-panel-group tsd-member-group">
62
65
  <h2>Properties</h2>
63
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="existingFields" class="tsd-anchor"></a>
66
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="existingFields" class="tsd-anchor"></a>
64
67
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>existing<wbr/>Fields</span><a href="#existingFields" 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
68
  <div class="tsd-signature">existing<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
66
69
  <ul>
67
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></section>
68
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="inconsistencies" class="tsd-anchor"></a>
70
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></section>
71
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="inconsistencies" class="tsd-anchor"></a>
69
72
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>inconsistencies</span><a href="#inconsistencies" 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>
70
73
  <div class="tsd-signature">inconsistencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Inconsistencies</span></div><aside class="tsd-sources">
71
74
  <ul>
72
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
73
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="missingFields" class="tsd-anchor"></a>
75
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
76
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="missingFields" class="tsd-anchor"></a>
74
77
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>missing<wbr/>Fields</span><a href="#missingFields" 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>
75
78
  <div class="tsd-signature">missing<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FieldStore</span></div><aside class="tsd-sources">
76
79
  <ul>
77
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/fieldAnalyser/fieldAnalyser.ts#L22">src/fieldAnalyser/fieldAnalyser.ts:22</a></li></ul></aside></section></section>
80
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L22">src/fieldAnalyser/fieldAnalyser.ts:22</a></li></ul></aside></section></section>
78
81
  <section class="tsd-panel-group tsd-member-group">
79
82
  <h2>Methods</h2>
80
83
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="add" class="tsd-anchor"></a>
81
84
  <h3 class="tsd-anchor-link"><span>add</span><a href="#add" 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
85
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
83
- <li class="tsd-signature" id="add.add-1">add<span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a><span class="tsd-signature-symbol">&gt;</span></li></ul>
84
- <ul class="tsd-descriptions">
86
+ <li class="tsd-signature tsd-anchor-link" id="add.add-1">add<span class="tsd-signature-symbol">(</span>batch<span class="tsd-signature-symbol">: </span><a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a><span class="tsd-signature-symbol">&gt;</span><a href="#add.add-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></li>
85
87
  <li class="tsd-description">
86
88
  <div class="tsd-comment tsd-typography"><p>Adds a batch of document builders to the analyser to extract all the missing fields that need to be created in the organization.
87
89
  This method can be called as many time as needed as it will take into consideration document builders previously added.</p>
@@ -92,49 +94,54 @@ This method can be called as many time as needed as it will take into considerat
92
94
  <ul class="tsd-parameter-list">
93
95
  <li>
94
96
  <h5>batch: <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
95
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
96
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="ensureExistingFields" class="tsd-anchor"></a>
97
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
98
+ <ul>
99
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L37">src/fieldAnalyser/fieldAnalyser.ts:37</a></li></ul></aside></li></ul></section>
100
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensureExistingFields" class="tsd-anchor"></a>
97
101
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ensure<wbr/>Existing<wbr/>Fields</span><a href="#ensureExistingFields" 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>
98
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
99
- <li class="tsd-signature" id="ensureExistingFields.ensureExistingFields-1">ensure<wbr/>Existing<wbr/>Fields<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul>
100
- <ul class="tsd-descriptions">
102
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
103
+ <li class="tsd-signature tsd-anchor-link" id="ensureExistingFields.ensureExistingFields-1">ensure<wbr/>Existing<wbr/>Fields<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#ensureExistingFields.ensureExistingFields-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></li>
101
104
  <li class="tsd-description">
102
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
103
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="ensurePermanentId" class="tsd-anchor"></a>
105
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
106
+ <ul>
107
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L102">src/fieldAnalyser/fieldAnalyser.ts:102</a></li></ul></aside></li></ul></section>
108
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensurePermanentId" class="tsd-anchor"></a>
104
109
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ensure<wbr/>Permanent<wbr/>Id</span><a href="#ensurePermanentId" 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>
105
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
106
- <li class="tsd-signature" id="ensurePermanentId.ensurePermanentId-1">ensure<wbr/>Permanent<wbr/>Id<span class="tsd-signature-symbol">(</span>fieldStore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FieldStore</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
107
- <ul class="tsd-descriptions">
110
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
111
+ <li class="tsd-signature tsd-anchor-link" id="ensurePermanentId.ensurePermanentId-1">ensure<wbr/>Permanent<wbr/>Id<span class="tsd-signature-symbol">(</span>fieldStore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FieldStore</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#ensurePermanentId.ensurePermanentId-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></li>
108
112
  <li class="tsd-description">
109
113
  <div class="tsd-parameters">
110
114
  <h4 class="tsd-parameters-title">Parameters</h4>
111
115
  <ul class="tsd-parameter-list">
112
116
  <li>
113
117
  <h5>fieldStore: <span class="tsd-signature-type">FieldStore</span></h5></li></ul></div>
114
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section>
115
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="removeInconsistentFields" class="tsd-anchor"></a>
118
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
119
+ <ul>
120
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L109">src/fieldAnalyser/fieldAnalyser.ts:109</a></li></ul></aside></li></ul></section>
121
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="removeInconsistentFields" class="tsd-anchor"></a>
116
122
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>remove<wbr/>Inconsistent<wbr/>Fields</span><a href="#removeInconsistentFields" 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>
117
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
118
- <li class="tsd-signature" id="removeInconsistentFields.removeInconsistentFields-1">remove<wbr/>Inconsistent<wbr/>Fields<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
119
- <ul class="tsd-descriptions">
123
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
124
+ <li class="tsd-signature tsd-anchor-link" id="removeInconsistentFields.removeInconsistentFields-1">remove<wbr/>Inconsistent<wbr/>Fields<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeInconsistentFields.removeInconsistentFields-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></li>
120
125
  <li class="tsd-description">
121
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section>
126
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
127
+ <ul>
128
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L72">src/fieldAnalyser/fieldAnalyser.ts:72</a></li></ul></aside></li></ul></section>
122
129
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="report" class="tsd-anchor"></a>
123
130
  <h3 class="tsd-anchor-link"><span>report</span><a href="#report" 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>
124
131
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
125
- <li class="tsd-signature" id="report.report-1">report<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FieldAnalyserReport</span></li></ul>
126
- <ul class="tsd-descriptions">
132
+ <li class="tsd-signature tsd-anchor-link" id="report.report-1">report<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FieldAnalyserReport</span><a href="#report.report-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></li>
127
133
  <li class="tsd-description">
128
134
  <div class="tsd-comment tsd-typography"><p>Returns the analyser report containing the fields to create as well as the type inconsistencies in the documents</p>
129
135
 
130
136
  <h3>Returns</h3><p>{FieldAnalyserReport}</p>
131
137
  </div>
132
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FieldAnalyserReport</span></h4></li></ul></section>
133
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="storeMetadata" class="tsd-anchor"></a>
138
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FieldAnalyserReport</span></h4><aside class="tsd-sources">
139
+ <ul>
140
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L62">src/fieldAnalyser/fieldAnalyser.ts:62</a></li></ul></aside></li></ul></section>
141
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="storeMetadata" class="tsd-anchor"></a>
134
142
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>store<wbr/>Metadata</span><a href="#storeMetadata" 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>
135
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
136
- <li class="tsd-signature" id="storeMetadata.storeMetadata-1">store<wbr/>Metadata<span class="tsd-signature-symbol">(</span>metadataKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadataValue<span class="tsd-signature-symbol">: </span><a href="../types/MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
137
- <ul class="tsd-descriptions">
143
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
144
+ <li class="tsd-signature tsd-anchor-link" id="storeMetadata.storeMetadata-1">store<wbr/>Metadata<span class="tsd-signature-symbol">(</span>metadataKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadataValue<span class="tsd-signature-symbol">: </span><a href="../types/MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#storeMetadata.storeMetadata-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></li>
138
145
  <li class="tsd-description">
139
146
  <div class="tsd-parameters">
140
147
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -143,7 +150,9 @@ This method can be called as many time as needed as it will take into considerat
143
150
  <h5>metadataKey: <span class="tsd-signature-type">string</span></h5></li>
144
151
  <li>
145
152
  <h5>metadataValue: <a href="../types/MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a></h5></li></ul></div>
146
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div>
153
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
154
+ <ul>
155
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/fieldAnalyser/fieldAnalyser.ts#L78">src/fieldAnalyser/fieldAnalyser.ts:78</a></li></ul></aside></li></ul></section></section></div>
147
156
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
148
157
  <div class="tsd-navigation settings">
149
158
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -171,15 +180,15 @@ This method can be called as many time as needed as it will take into considerat
171
180
  <li class="current tsd-kind-class"><a href="FieldAnalyser.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Field<wbr/>Analyser</span></a>
172
181
  <ul>
173
182
  <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="FieldAnalyser.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
174
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="FieldAnalyser.html#existingFields" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>existing<wbr/>Fields</a></li>
175
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="FieldAnalyser.html#inconsistencies" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>inconsistencies</a></li>
176
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="FieldAnalyser.html#missingFields" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>missing<wbr/>Fields</a></li>
183
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#existingFields" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>existing<wbr/>Fields</a></li>
184
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#inconsistencies" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>inconsistencies</a></li>
185
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#missingFields" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>missing<wbr/>Fields</a></li>
177
186
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="FieldAnalyser.html#add" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add</a></li>
178
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="FieldAnalyser.html#ensureExistingFields" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>ensure<wbr/>Existing<wbr/>Fields</a></li>
179
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="FieldAnalyser.html#ensurePermanentId" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>ensure<wbr/>Permanent<wbr/>Id</a></li>
180
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="FieldAnalyser.html#removeInconsistentFields" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>remove<wbr/>Inconsistent<wbr/>Fields</a></li>
187
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#ensureExistingFields" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>ensure<wbr/>Existing<wbr/>Fields</a></li>
188
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#ensurePermanentId" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>ensure<wbr/>Permanent<wbr/>Id</a></li>
189
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#removeInconsistentFields" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>remove<wbr/>Inconsistent<wbr/>Fields</a></li>
181
190
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="FieldAnalyser.html#report" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>report</a></li>
182
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="FieldAnalyser.html#storeMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>store<wbr/>Metadata</a></li></ul></li></ul></nav></div></div>
191
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="FieldAnalyser.html#storeMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>store<wbr/>Metadata</a></li></ul></li></ul></nav></div></div>
183
192
  <div class="container tsd-generator">
184
193
  <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
185
194
  <div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/classes/GroupSecurityIdentityBuilder.html CHANGED
@@ -25,7 +25,9 @@
25
25
  <section class="tsd-panel">
26
26
  <h4>Implements</h4>
27
27
  <ul class="tsd-hierarchy">
28
- <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section>
28
+ <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
29
+ <ul>
30
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/securityIdentityBuilder.ts#L90">src/securityIdentityBuilder.ts:90</a></li></ul></aside>
29
31
  <section class="tsd-panel-group tsd-index-group">
30
32
  <section class="tsd-panel tsd-index-panel">
31
33
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -44,8 +46,7 @@
44
46
  <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
45
47
  <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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>
46
48
  <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
47
- <li class="tsd-signature" id="constructor.new_GroupSecurityIdentityBuilder">new <wbr/>Group<wbr/>Security<wbr/>Identity<wbr/>Builder<span class="tsd-signature-symbol">(</span>group<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>, securityProvider<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><a href="GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></li></ul>
48
- <ul class="tsd-descriptions">
49
+ <li class="tsd-signature tsd-anchor-link" id="constructor.new_GroupSecurityIdentityBuilder">new <wbr/>Group<wbr/>Security<wbr/>Identity<wbr/>Builder<span class="tsd-signature-symbol">(</span>group<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>, securityProvider<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><a href="GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a><a href="#constructor.new_GroupSecurityIdentityBuilder" 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></li>
49
50
  <li class="tsd-description">
50
51
  <div class="tsd-comment tsd-typography"><p>Pass either a single <code>group</code>, or an array of <code>group</code> to create multiple identities.</p>
51
52
  </div>
@@ -56,20 +57,23 @@
56
57
  <h5>group: <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></h5></li>
57
58
  <li>
58
59
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
59
- <h4 class="tsd-returns-title">Returns <a href="GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></h4></li></ul></section></section>
60
+ <h4 class="tsd-returns-title">Returns <a href="GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
61
+ <ul>
62
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/securityIdentityBuilder.ts#L96">src/securityIdentityBuilder.ts:96</a></li></ul></aside></li></ul></section></section>
60
63
  <section class="tsd-panel-group tsd-member-group">
61
64
  <h2>Methods</h2>
62
65
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
63
66
  <h3 class="tsd-anchor-link"><span>build</span><a href="#build" 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>
64
67
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
65
- <li class="tsd-signature" id="build.build-1">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></li></ul>
66
- <ul class="tsd-descriptions">
68
+ <li class="tsd-signature tsd-anchor-link" id="build.build-1">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><a href="#build.build-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></li>
67
69
  <li class="tsd-description">
68
70
  <div class="tsd-comment tsd-typography"><p>Build and return the security identity or identities.</p>
69
71
 
70
72
  <h3>Returns</h3></div>
71
73
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
72
- <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p></aside></li></ul></section></section></div>
74
+ <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
75
+ <ul>
76
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6755192/src/securityIdentityBuilder.ts#L105">src/securityIdentityBuilder.ts:105</a></li></ul></aside></li></ul></section></section></div>
73
77
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
74
78
  <div class="tsd-navigation settings">
75
79
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">