@docbrasil/api-systemmanager 1.1.25 → 1.1.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.
package/doc/api.md CHANGED
@@ -1503,6 +1503,9 @@ Class for documents, permission user
1503
1503
  * [.uploadSignedDocument(params)](#Documents+uploadSignedDocument) ⇒ <code>Promise.&lt;boolean&gt;</code>
1504
1504
  * [.checkPrimaryKeys(params, session)](#Documents+checkPrimaryKeys) ⇒ <code>Promise.&lt;array&gt;</code> \| <code>array.&lt;string&gt;</code>
1505
1505
  * [.searchDocuments(params, session)](#Documents+searchDocuments) ⇒ <code>promise</code> \| <code>number</code> \| <code>array.&lt;object&gt;</code> \| <code>number</code> \| <code>number</code>
1506
+ * [.exportExcelForAllPages(params, session)](#Documents+exportExcelForAllPages) ⇒ <code>promise</code>
1507
+ * [.exportWmsExcelForAllPages(params, session)](#Documents+exportWmsExcelForAllPages) ⇒ <code>promise</code>
1508
+ * [.performDownloadComplete(params, session)](#Documents+performDownloadComplete) ⇒ <code>promise</code>
1506
1509
 
1507
1510
  <a name="Documents+add"></a>
1508
1511
 
@@ -1905,6 +1908,100 @@ const params = {
1905
1908
  const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
1906
1909
  const retSearch = await api.user.document.searchDocuments(params, session);
1907
1910
  ```
1911
+ <a name="Documents+exportExcelForAllPages"></a>
1912
+
1913
+ ### documents.exportExcelForAllPages(params, session) ⇒ <code>promise</code>
1914
+ Method to export excel for all pages
1915
+
1916
+ **Kind**: instance method of [<code>Documents</code>](#Documents)
1917
+ **Returns**: <code>promise</code> - returned data from the export excel for all pages
1918
+ **Access**: public
1919
+ **Author**: Myndware <augusto.pissarra@myndware.com>
1920
+
1921
+ | Param | Type | Description |
1922
+ | --- | --- | --- |
1923
+ | params | <code>object</code> | Params to export excel for all pages |
1924
+ | params.query | <code>object</code> | Export excel for all pages query |
1925
+ | params.orgId | <code>object</code> | Organization id (_id database) |
1926
+ | session | <code>string</code> | Session, token JWT |
1927
+
1928
+ **Example**
1929
+ ```js
1930
+ const API = require('@docbrasil/api-systemmanager');
1931
+ const api = new API();
1932
+ const params = {
1933
+ query: {p: 20, i: 1, s: 'Mais recentes', as: '', m: 'w', ai: '57e6a3bd6be6b45210833fae'},
1934
+ orgId: '55e4a3bd6be6b45210833fae',
1935
+ };
1936
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
1937
+ const retSearch = await api.user.document.exportExcelForAllPages(params, session);
1938
+ ```
1939
+ <a name="Documents+exportWmsExcelForAllPages"></a>
1940
+
1941
+ ### documents.exportWmsExcelForAllPages(params, session) ⇒ <code>promise</code>
1942
+ Method to export Wms Excel for all pages
1943
+
1944
+ **Kind**: instance method of [<code>Documents</code>](#Documents)
1945
+ **Returns**: <code>promise</code> - returned data from the export Wms Excel for all pages
1946
+ **Access**: public
1947
+ **Author**: Myndware <augusto.pissarra@myndware.com>
1948
+
1949
+ | Param | Type | Description |
1950
+ | --- | --- | --- |
1951
+ | params | <code>object</code> | Params to export Wms Excel for all pages |
1952
+ | params.query | <code>object</code> | export Wms Excel for all pages query |
1953
+ | params.orgId | <code>object</code> | Organization id (_id database) |
1954
+ | session | <code>string</code> | Session, token JWT |
1955
+
1956
+ **Example**
1957
+ ```js
1958
+ const API = require('@docbrasil/api-systemmanager');
1959
+ const api = new API();
1960
+ const params = {
1961
+ query: {p: 20, i: 1, s: 'Mais recentes', as: '', m: 'w', ai: '57e6a3bd6be6b45210833fae'},
1962
+ orgId: '55e4a3bd6be6b45210833fae',
1963
+ };
1964
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
1965
+ const retSearch = await api.user.document.exportWmsExcelForAllPages(params, session);
1966
+ ```
1967
+ <a name="Documents+performDownloadComplete"></a>
1968
+
1969
+ ### documents.performDownloadComplete(params, session) ⇒ <code>promise</code>
1970
+ Method to perform download complete for all pages
1971
+
1972
+ **Kind**: instance method of [<code>Documents</code>](#Documents)
1973
+ **Returns**: <code>promise</code> - returned data from the perform download complete for all pages
1974
+ **Access**: public
1975
+ **Author**: Myndware <augusto.pissarra@myndware.com>
1976
+
1977
+ | Param | Type | Description |
1978
+ | --- | --- | --- |
1979
+ | params | <code>object</code> | Params to perform download complete for all pages |
1980
+ | params.data | <code>object</code> | data to be send to download |
1981
+ | params.query | <code>object</code> | perform download complete for all pages query |
1982
+ | params.orgId | <code>object</code> | Organization id (_id database) |
1983
+ | session | <code>string</code> | Session, token JWT |
1984
+
1985
+ **Example**
1986
+ ```js
1987
+ const API = require('@docbrasil/api-systemmanager');
1988
+ const api = new API();
1989
+ const params = {
1990
+ query: {p: 20, i: 1, s: 'Mais recentes', as: '', m: 'w', ai: '57e6a3bd6be6b45210833fae'},
1991
+ orgId: '55e4a3bd6be6b45210833fae',
1992
+ data: {
1993
+ destAws = {
1994
+ destAwsKey: '',
1995
+ destAwsSecret: '',
1996
+ destAwsBucket: '',
1997
+ destAwsRegion: ''
1998
+ },
1999
+ maxFileSize: ''
2000
+ }
2001
+ };
2002
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2003
+ const retSearch = await api.user.document.performDownloadComplete(params, session);
2004
+ ```
1908
2005
  <a name="Help"></a>
1909
2006
 
1910
2007
  ## Help