@emilgroup/tenant-sdk 1.4.0 → 1.5.1

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 (80) hide show
  1. package/.openapi-generator/FILES +15 -0
  2. package/README.md +5 -22
  3. package/api/custom-schema-api.ts +0 -4
  4. package/api/data-report-api.ts +673 -0
  5. package/api/data-report-executor-api.ts +161 -0
  6. package/api/invite-organizations-api.ts +0 -4
  7. package/api/invite-users-api.ts +0 -4
  8. package/api/list-organization-invitations-api.ts +0 -4
  9. package/api/organizations-api.ts +0 -4
  10. package/api/re-invite-an-organization-api.ts +0 -4
  11. package/api/roles-api.ts +0 -4
  12. package/api/settings-api.ts +0 -4
  13. package/api/users-api.ts +0 -4
  14. package/api.ts +4 -4
  15. package/base.ts +59 -93
  16. package/common.ts +0 -1
  17. package/configuration.ts +0 -8
  18. package/dist/api/custom-schema-api.js +4 -8
  19. package/dist/api/data-report-api.d.ts +380 -0
  20. package/dist/api/data-report-api.js +632 -0
  21. package/dist/api/data-report-executor-api.d.ts +93 -0
  22. package/dist/api/data-report-executor-api.js +220 -0
  23. package/dist/api/invite-organizations-api.js +1 -5
  24. package/dist/api/invite-users-api.js +5 -9
  25. package/dist/api/list-organization-invitations-api.js +1 -5
  26. package/dist/api/organizations-api.js +3 -7
  27. package/dist/api/re-invite-an-organization-api.js +1 -5
  28. package/dist/api/roles-api.js +1 -5
  29. package/dist/api/settings-api.js +1 -5
  30. package/dist/api/users-api.js +9 -13
  31. package/dist/api.d.ts +2 -0
  32. package/dist/api.js +2 -0
  33. package/dist/base.d.ts +5 -9
  34. package/dist/base.js +40 -136
  35. package/dist/common.d.ts +0 -1
  36. package/dist/common.js +1 -2
  37. package/dist/configuration.d.ts +0 -7
  38. package/dist/models/create-data-report-request-dto.d.ts +61 -0
  39. package/dist/models/create-data-report-request-dto.js +15 -0
  40. package/dist/models/create-data-report-response-class.d.ts +25 -0
  41. package/dist/models/create-data-report-response-class.js +15 -0
  42. package/dist/models/data-report-class.d.ts +79 -0
  43. package/dist/models/data-report-class.js +15 -0
  44. package/dist/models/data-report-filter-class.d.ts +72 -0
  45. package/dist/models/data-report-filter-class.js +15 -0
  46. package/dist/models/data-report-filter-dto.d.ts +48 -0
  47. package/dist/models/data-report-filter-dto.js +15 -0
  48. package/dist/models/data-report-filter-single-value-dto.d.ts +42 -0
  49. package/dist/models/data-report-filter-single-value-dto.js +15 -0
  50. package/dist/models/data-report-filter-value-dto.d.ts +31 -0
  51. package/dist/models/data-report-filter-value-dto.js +15 -0
  52. package/dist/models/get-data-report-response-class.d.ts +25 -0
  53. package/dist/models/get-data-report-response-class.js +15 -0
  54. package/dist/models/index.d.ts +13 -0
  55. package/dist/models/index.js +13 -0
  56. package/dist/models/list-data-reports-response-class.d.ts +31 -0
  57. package/dist/models/list-data-reports-response-class.js +15 -0
  58. package/dist/models/run-data-report-request-dto.d.ts +31 -0
  59. package/dist/models/run-data-report-request-dto.js +15 -0
  60. package/dist/models/run-data-report-response-class.d.ts +24 -0
  61. package/dist/models/run-data-report-response-class.js +15 -0
  62. package/dist/models/update-data-report-request-dto.d.ts +61 -0
  63. package/dist/models/update-data-report-request-dto.js +15 -0
  64. package/dist/models/update-data-report-response-class.d.ts +25 -0
  65. package/dist/models/update-data-report-response-class.js +15 -0
  66. package/models/create-data-report-request-dto.ts +67 -0
  67. package/models/create-data-report-response-class.ts +31 -0
  68. package/models/data-report-class.ts +85 -0
  69. package/models/data-report-filter-class.ts +78 -0
  70. package/models/data-report-filter-dto.ts +54 -0
  71. package/models/data-report-filter-single-value-dto.ts +48 -0
  72. package/models/data-report-filter-value-dto.ts +37 -0
  73. package/models/get-data-report-response-class.ts +31 -0
  74. package/models/index.ts +13 -0
  75. package/models/list-data-reports-response-class.ts +37 -0
  76. package/models/run-data-report-request-dto.ts +37 -0
  77. package/models/run-data-report-response-class.ts +30 -0
  78. package/models/update-data-report-request-dto.ts +67 -0
  79. package/models/update-data-report-response-class.ts +31 -0
  80. package/package.json +3 -5
@@ -4,6 +4,8 @@
4
4
  README.md
5
5
  api.ts
6
6
  api/custom-schema-api.ts
7
+ api/data-report-api.ts
8
+ api/data-report-executor-api.ts
7
9
  api/invite-organizations-api.ts
8
10
  api/invite-users-api.ts
9
11
  api/list-organization-invitations-api.ts
@@ -23,11 +25,18 @@ models/batch-delete-request-dto.ts
23
25
  models/batch-delete-response-class.ts
24
26
  models/create-custom-schema-request-dto.ts
25
27
  models/create-custom-schema-response-class.ts
28
+ models/create-data-report-request-dto.ts
29
+ models/create-data-report-response-class.ts
26
30
  models/create-permission-request-dto.ts
27
31
  models/create-role-request-dto.ts
28
32
  models/create-tenant-request-dto.ts
29
33
  models/custom-field-dto.ts
30
34
  models/custom-schema-class.ts
35
+ models/data-report-class.ts
36
+ models/data-report-filter-class.ts
37
+ models/data-report-filter-dto.ts
38
+ models/data-report-filter-single-value-dto.ts
39
+ models/data-report-filter-value-dto.ts
31
40
  models/dbconfig-dto.ts
32
41
  models/delete-response-class.ts
33
42
  models/disable-user-response-class.ts
@@ -37,6 +46,7 @@ models/enable-user-response-class.ts
37
46
  models/enable-users-request-dto.ts
38
47
  models/enable-users-response-class.ts
39
48
  models/get-custom-schema-response-class.ts
49
+ models/get-data-report-response-class.ts
40
50
  models/get-organization-response-class.ts
41
51
  models/get-settings-response-class.ts
42
52
  models/get-user-response-class.ts
@@ -48,6 +58,7 @@ models/invite-user-response-class.ts
48
58
  models/invite-users-request-dto.ts
49
59
  models/invite-users-response-class.ts
50
60
  models/list-custom-schemas-response-class.ts
61
+ models/list-data-reports-response-class.ts
51
62
  models/list-invites-response-class.ts
52
63
  models/list-org-invitations-response-class.ts
53
64
  models/list-organizations-response-class.ts
@@ -59,12 +70,16 @@ models/organization-class.ts
59
70
  models/permission-class.ts
60
71
  models/re-invite-org-request-dto.ts
61
72
  models/role-class.ts
73
+ models/run-data-report-request-dto.ts
74
+ models/run-data-report-response-class.ts
62
75
  models/set-setting-request-dto.ts
63
76
  models/set-user-setting-response-class.ts
64
77
  models/subscription-class.ts
65
78
  models/tenant-admin-user-dto.ts
66
79
  models/update-custom-schema-request-dto.ts
67
80
  models/update-custom-schema-response-class.ts
81
+ models/update-data-report-request-dto.ts
82
+ models/update-data-report-response-class.ts
68
83
  models/update-organization-request-dto-rest.ts
69
84
  models/update-organization-response-class.ts
70
85
  models/update-role-request-dto.ts
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Emil Tenant SDK
2
2
 
3
- This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated Node module can be used with Nodejs based applications.
3
+ This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated module can be used with client-based applications (i.e. React).
4
4
 
5
5
  Language level
6
6
  * ES5 - you must have a Promises/A+ library installed
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/tenant-sdk@1.4.0 --save
20
+ npm install @emilgroup/tenant-sdk@1.5.1 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/tenant-sdk@1.4.0
24
+ yarn add @emilgroup/tenant-sdk@1.5.1
25
25
  ```
26
26
 
27
27
  And then you can import `UsersApi`.
@@ -31,32 +31,15 @@ import { UsersApi } from '@emilgroup/tenant-sdk'
31
31
 
32
32
  const usersApi = new UsersApi();
33
33
  ```
34
- ## Credentials
35
34
 
36
- To use authentication protected endpoints, you have to first authorize. To do so, the easiest way is to provide a configuration file under `~/.emil/credentials` with the following content:
37
-
38
- ```shell
39
- emil_username=XXXXX@XXXX.XXX
40
- emil_password=XXXXXXXXXXXXXX
41
- ```
42
-
43
- It is also possible to provide environment variables instead:
44
-
45
- ```shell
46
- export EMIL_USERNAME=XXXXX@XXXX.XXX
47
- export EMIL_PASSWORD=XXXXXXXXXXXXXX
48
- ```
49
-
50
- ## Example
51
-
52
- Here is a basic functionning example:
35
+ To use authentication protected endpoints, you have to first authorize. To do so, use the `authorize` function in `UsersApi`:
53
36
 
54
37
  ```ts
55
38
  async function listUsers(): Promise<Void> {
56
39
  try {
57
40
  const usersApi = new UsersApi();
58
41
 
59
- await usersApi.initialize(); // should be called only once per Api.
42
+ await usersApi.authorize('username', 'password');
60
43
 
61
44
  const { data: { items } } = await usersApi.listUsers();
62
45
 
@@ -32,10 +32,6 @@ import { ListCustomSchemasResponseClass } from '../models';
32
32
  import { UpdateCustomSchemaRequestDto } from '../models';
33
33
  // @ts-ignore
34
34
  import { UpdateCustomSchemaResponseClass } from '../models';
35
- // URLSearchParams not necessarily used
36
- // @ts-ignore
37
- import { URL, URLSearchParams } from 'url';
38
- const FormData = require('form-data');
39
35
  /**
40
36
  * CustomSchemaApi - axios parameter creator
41
37
  * @export