@extrahorizon/javascript-sdk 8.2.0 → 8.2.1-dev-48-41fd1f1
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/CHANGELOG.md +1177 -1161
- package/README.md +108 -119
- package/build/index.cjs.js +1 -1
- package/build/index.mjs +1 -1
- package/build/types/btoa.d.ts +6 -6
- package/build/types/client.d.ts +136 -136
- package/build/types/constants.d.ts +15 -15
- package/build/types/errorHandler.d.ts +2 -2
- package/build/types/errors.d.ts +332 -332
- package/build/types/http/client.d.ts +2 -2
- package/build/types/http/index.d.ts +4 -4
- package/build/types/http/interceptors.d.ts +9 -9
- package/build/types/http/oAuth1Signature.d.ts +14 -14
- package/build/types/http/oauth1.d.ts +3 -3
- package/build/types/http/oauth2.d.ts +3 -3
- package/build/types/http/proxy.d.ts +3 -3
- package/build/types/http/types.d.ts +331 -331
- package/build/types/http/utils.d.ts +21 -21
- package/build/types/index.d.ts +9 -9
- package/build/types/mock.d.ts +43 -43
- package/build/types/mockType.d.ts +1547 -1511
- package/build/types/parseStoredCredentials.d.ts +11 -11
- package/build/types/rql/index.d.ts +16 -16
- package/build/types/rql/parser.d.ts +1 -1
- package/build/types/rql/types.d.ts +168 -168
- package/build/types/services/auth/applications/index.d.ts +5 -5
- package/build/types/services/auth/applications/types.d.ts +260 -190
- package/build/types/services/auth/index.d.ts +3 -3
- package/build/types/services/auth/oauth1/index.d.ts +5 -5
- package/build/types/services/auth/oauth1/types.d.ts +63 -63
- package/build/types/services/auth/oauth2/index.d.ts +5 -5
- package/build/types/services/auth/oauth2/types.d.ts +52 -52
- package/build/types/services/auth/oidc/index.d.ts +5 -5
- package/build/types/services/auth/oidc/loginAttempts/index.d.ts +5 -5
- package/build/types/services/auth/oidc/loginAttempts/types.d.ts +67 -67
- package/build/types/services/auth/oidc/providers/index.d.ts +5 -5
- package/build/types/services/auth/oidc/providers/types.d.ts +144 -144
- package/build/types/services/auth/oidc/types.d.ts +40 -40
- package/build/types/services/auth/types.d.ts +39 -39
- package/build/types/services/auth/users/index.d.ts +5 -5
- package/build/types/services/auth/users/types.d.ts +121 -121
- package/build/types/services/configurations/general.d.ts +5 -5
- package/build/types/services/configurations/groups.d.ts +5 -5
- package/build/types/services/configurations/index.d.ts +10 -10
- package/build/types/services/configurations/patients.d.ts +5 -5
- package/build/types/services/configurations/staff.d.ts +5 -5
- package/build/types/services/configurations/types.d.ts +222 -222
- package/build/types/services/configurations/users.d.ts +5 -5
- package/build/types/services/data/comments.d.ts +5 -5
- package/build/types/services/data/documents.d.ts +5 -5
- package/build/types/services/data/index.d.ts +13 -13
- package/build/types/services/data/indexes.d.ts +5 -5
- package/build/types/services/data/infrastructure.d.ts +10 -10
- package/build/types/services/data/json-schema.d.ts +121 -121
- package/build/types/services/data/properties.d.ts +5 -5
- package/build/types/services/data/schemas.d.ts +5 -5
- package/build/types/services/data/statuses.d.ts +5 -5
- package/build/types/services/data/transitions.d.ts +5 -5
- package/build/types/services/data/types.d.ts +899 -899
- package/build/types/services/dispatchers/actions/index.d.ts +5 -5
- package/build/types/services/dispatchers/actions/types.d.ts +78 -78
- package/build/types/services/dispatchers/dispatchers/index.d.ts +5 -5
- package/build/types/services/dispatchers/dispatchers/types.d.ts +111 -111
- package/build/types/services/dispatchers/index.d.ts +7 -7
- package/build/types/services/dispatchers/types.d.ts +2 -2
- package/build/types/services/events/events.d.ts +5 -5
- package/build/types/services/events/health.d.ts +9 -9
- package/build/types/services/events/index.d.ts +6 -6
- package/build/types/services/events/subscriptions.d.ts +5 -5
- package/build/types/services/events/types.d.ts +90 -90
- package/build/types/services/files/files.d.ts +5 -5
- package/build/types/services/files/formHelpers.d.ts +3 -3
- package/build/types/services/files/index.d.ts +6 -6
- package/build/types/services/files/settings/index.d.ts +5 -5
- package/build/types/services/files/settings/types.d.ts +38 -38
- package/build/types/services/files/tokens.d.ts +5 -5
- package/build/types/services/files/types.d.ts +185 -185
- package/build/types/services/helpers.d.ts +7 -7
- package/build/types/services/http-client.d.ts +22 -22
- package/build/types/services/index.d.ts +15 -15
- package/build/types/services/localizations/countries.d.ts +5 -5
- package/build/types/services/localizations/health.d.ts +9 -9
- package/build/types/services/localizations/index.d.ts +4 -4
- package/build/types/services/localizations/languages.d.ts +5 -5
- package/build/types/services/localizations/localizations.d.ts +5 -5
- package/build/types/services/localizations/types.d.ts +145 -145
- package/build/types/services/logs/access/index.d.ts +5 -5
- package/build/types/services/logs/access/types.d.ts +41 -41
- package/build/types/services/logs/index.d.ts +3 -3
- package/build/types/services/logs/types.d.ts +4 -4
- package/build/types/services/mails/index.d.ts +3 -3
- package/build/types/services/mails/mails.d.ts +5 -5
- package/build/types/services/mails/types.d.ts +141 -141
- package/build/types/services/notifications/health.d.ts +9 -9
- package/build/types/services/notifications/index.d.ts +7 -7
- package/build/types/services/notifications/notifications.d.ts +5 -5
- package/build/types/services/notifications/settings.d.ts +5 -5
- package/build/types/services/notifications/types.d.ts +222 -222
- package/build/types/services/payments/appStore.d.ts +5 -5
- package/build/types/services/payments/appStoreSubscriptions.d.ts +5 -5
- package/build/types/services/payments/health.d.ts +9 -9
- package/build/types/services/payments/index.d.ts +15 -15
- package/build/types/services/payments/orders.d.ts +5 -5
- package/build/types/services/payments/playStore.d.ts +5 -5
- package/build/types/services/payments/playStoreHistory.d.ts +5 -5
- package/build/types/services/payments/playStoreSubscriptions.d.ts +5 -5
- package/build/types/services/payments/products.d.ts +5 -5
- package/build/types/services/payments/stripe.d.ts +5 -5
- package/build/types/services/payments/subscriptions.d.ts +5 -5
- package/build/types/services/payments/types.d.ts +1189 -1189
- package/build/types/services/profiles/groups.d.ts +5 -5
- package/build/types/services/profiles/health.d.ts +9 -9
- package/build/types/services/profiles/index.d.ts +9 -9
- package/build/types/services/profiles/logs.d.ts +5 -5
- package/build/types/services/profiles/profiles.d.ts +5 -5
- package/build/types/services/profiles/types.d.ts +370 -369
- package/build/types/services/tasks/api/index.d.ts +5 -5
- package/build/types/services/tasks/api/types.d.ts +146 -146
- package/build/types/services/tasks/apiRequests/index.d.ts +5 -5
- package/build/types/services/tasks/apiRequests/logs/index.d.ts +5 -5
- package/build/types/services/tasks/apiRequests/logs/types.d.ts +25 -25
- package/build/types/services/tasks/apiRequests/types.d.ts +83 -83
- package/build/types/services/tasks/functions/index.d.ts +5 -5
- package/build/types/services/tasks/functions/types.d.ts +27 -27
- package/build/types/services/tasks/index.d.ts +15 -15
- package/build/types/services/tasks/logs/index.d.ts +5 -5
- package/build/types/services/tasks/logs/types.d.ts +28 -28
- package/build/types/services/tasks/schedules/index.d.ts +5 -5
- package/build/types/services/tasks/schedules/types.d.ts +88 -88
- package/build/types/services/tasks/tasks.d.ts +5 -5
- package/build/types/services/tasks/types.d.ts +107 -107
- package/build/types/services/templates/index.d.ts +3 -3
- package/build/types/services/templates/templates.d.ts +5 -5
- package/build/types/services/templates/types.d.ts +202 -202
- package/build/types/services/types.d.ts +77 -77
- package/build/types/services/users/activationRequests/index.d.ts +4 -4
- package/build/types/services/users/activationRequests/types.d.ts +70 -70
- package/build/types/services/users/forgotPasswordRequests/index.d.ts +4 -4
- package/build/types/services/users/forgotPasswordRequests/types.d.ts +70 -70
- package/build/types/services/users/globalRoles.d.ts +5 -5
- package/build/types/services/users/groupRoles.d.ts +5 -5
- package/build/types/services/users/health.d.ts +9 -9
- package/build/types/services/users/index.d.ts +16 -16
- package/build/types/services/users/settings/index.d.ts +4 -4
- package/build/types/services/users/settings/types.d.ts +47 -47
- package/build/types/services/users/types.d.ts +1116 -1055
- package/build/types/services/users/users.d.ts +5 -5
- package/build/types/sha1.d.ts +11 -11
- package/build/types/types.d.ts +102 -102
- package/build/types/utils.d.ts +4 -4
- package/build/types/version.d.ts +1 -1
- package/package.json +62 -62
|
@@ -1,222 +1,222 @@
|
|
|
1
|
-
import { Entity, Timestamps, ObjectId, AffectedRecords, OptionsBase, OptionsWithRql } from '../types';
|
|
2
|
-
export declare type Configuration = Record<string, any>;
|
|
3
|
-
export interface GeneralConfigurationInput {
|
|
4
|
-
data: Configuration;
|
|
5
|
-
staffConfiguration: Configuration;
|
|
6
|
-
patientConfiguration: Configuration;
|
|
7
|
-
groupConfiguration?: Configuration;
|
|
8
|
-
userConfiguration?: Configuration;
|
|
9
|
-
}
|
|
10
|
-
export declare type GeneralConfiguration = GeneralConfigurationInput & Entity & Timestamps;
|
|
11
|
-
export interface GroupConfigurationInput {
|
|
12
|
-
data?: Configuration;
|
|
13
|
-
staffConfiguration?: Configuration;
|
|
14
|
-
patientConfiguration?: Configuration;
|
|
15
|
-
}
|
|
16
|
-
export declare type GroupConfiguration = GroupConfigurationInput & Entity & Timestamps;
|
|
17
|
-
export interface UserConfigurationInput {
|
|
18
|
-
data: Configuration;
|
|
19
|
-
}
|
|
20
|
-
export interface UserEnlistments {
|
|
21
|
-
staffConfigurations?: Array<EnlistmentConfiguration>;
|
|
22
|
-
patientConfigurations?: Array<EnlistmentConfiguration>;
|
|
23
|
-
}
|
|
24
|
-
export interface EnlistmentConfiguration {
|
|
25
|
-
groupId: ObjectId;
|
|
26
|
-
data: Configuration;
|
|
27
|
-
}
|
|
28
|
-
export declare type UserConfiguration = UserConfigurationInput & UserEnlistments & Entity & Timestamps;
|
|
29
|
-
export interface ConfigurationsGeneralService {
|
|
30
|
-
/**
|
|
31
|
-
* View the general configuration.
|
|
32
|
-
*
|
|
33
|
-
* Permission | Scope | Effect
|
|
34
|
-
* - | - | -
|
|
35
|
-
* none | | Everyone can use this endpoint
|
|
36
|
-
* @returns GeneralConfiguration
|
|
37
|
-
*/
|
|
38
|
-
get(options?: OptionsBase): Promise<GeneralConfiguration>;
|
|
39
|
-
/**
|
|
40
|
-
* Update the general configuration
|
|
41
|
-
*
|
|
42
|
-
* Permission | Scope | Effect
|
|
43
|
-
* - | - | -
|
|
44
|
-
* `UPDATE_CONFIGURATIONS` | `global` | Required for this endpoint
|
|
45
|
-
* @param requestBody GeneralConfigurationInput
|
|
46
|
-
* @param rql Add filters to the requested list.
|
|
47
|
-
* @returns AffectedRecords
|
|
48
|
-
*/
|
|
49
|
-
update(requestBody: GeneralConfigurationInput, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
50
|
-
/**
|
|
51
|
-
* Delete fields from the general configuration.
|
|
52
|
-
*
|
|
53
|
-
* Permission | Scope | Effect
|
|
54
|
-
* - | - | -
|
|
55
|
-
* `UPDATE_CONFIGURATIONS` | `global` | Required for this endpoint
|
|
56
|
-
* @param requestBody list of fields to remove
|
|
57
|
-
* @param rql Add filters to the requested list.
|
|
58
|
-
* @returns AffectedRecords
|
|
59
|
-
*/
|
|
60
|
-
removeFields(requestBody: {
|
|
61
|
-
fields: Array<string>;
|
|
62
|
-
}, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
63
|
-
}
|
|
64
|
-
export interface ConfigurationsGroupsService {
|
|
65
|
-
/**
|
|
66
|
-
* View a group configuration
|
|
67
|
-
*
|
|
68
|
-
* Permission | Scope | Effect
|
|
69
|
-
* - | - | -
|
|
70
|
-
* `VIEW_PATIENT_CONFIGURATIONS` | `staff enlistment` | View the group its patient configuration
|
|
71
|
-
* `VIEW_STAFF_CONFIGURATIONS` | `staff enlistment` | View the group its staff configuration
|
|
72
|
-
* `VIEW_CONFIGURATIONS` | `staff enlistment` | View the group its full configuration
|
|
73
|
-
* `VIEW_CONFIGURATIONS` | `global` | View any group its full configuration
|
|
74
|
-
* @param groupId The id of the targeted group
|
|
75
|
-
* @returns GroupConfiguration
|
|
76
|
-
*/
|
|
77
|
-
get(groupId: ObjectId, options?: OptionsBase): Promise<GroupConfiguration>;
|
|
78
|
-
/**
|
|
79
|
-
* Update a group configuration.
|
|
80
|
-
*
|
|
81
|
-
* Permission | Scope | Effect
|
|
82
|
-
* - | - | -
|
|
83
|
-
* `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | Update the group its patient configuration
|
|
84
|
-
* `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | Update the group its staff configuration
|
|
85
|
-
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | Update the group its full configuration
|
|
86
|
-
* `UPDATE_CONFIGURATIONS` | `global` | Update any group its full configuration
|
|
87
|
-
* @param groupId The id of the targeted group
|
|
88
|
-
* @param requestBody GroupConfigurationInput
|
|
89
|
-
* @param rql Add filters to the requested list.
|
|
90
|
-
* @returns AffectedRecords
|
|
91
|
-
*/
|
|
92
|
-
update(groupId: ObjectId, requestBody: GroupConfigurationInput, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
93
|
-
/**
|
|
94
|
-
* Delete fields from a group configuration.
|
|
95
|
-
*
|
|
96
|
-
* Permission | Scope | Effect
|
|
97
|
-
* - | - | -
|
|
98
|
-
* `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | Update the group its patient configuration
|
|
99
|
-
* `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | Update the group its staff configuration
|
|
100
|
-
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | Update the group its full configuration
|
|
101
|
-
* `UPDATE_CONFIGURATIONS` | `global` | Update any group its full configuration
|
|
102
|
-
* @param groupId The id of the targeted group
|
|
103
|
-
* @param requestBody the list of fields to remove
|
|
104
|
-
* @param rql Add filters to the requested list.
|
|
105
|
-
* @returns AffectedRecords
|
|
106
|
-
*/
|
|
107
|
-
removeFields(groupId: ObjectId, requestBody: {
|
|
108
|
-
fields: Array<string>;
|
|
109
|
-
}, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
110
|
-
}
|
|
111
|
-
export interface ConfigurationsPatientsService {
|
|
112
|
-
/**
|
|
113
|
-
* Update a patient configuration for a group of a user.
|
|
114
|
-
*
|
|
115
|
-
* Permission | Scope | Effect
|
|
116
|
-
* - | - | -
|
|
117
|
-
* `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
|
|
118
|
-
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
|
|
119
|
-
* `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
|
|
120
|
-
* @param groupId The id of the targeted group
|
|
121
|
-
* @param userId The id of the targeted user
|
|
122
|
-
* @param requestBody UserConfigurationInput
|
|
123
|
-
* @returns AffectedRecords
|
|
124
|
-
*/
|
|
125
|
-
update(groupId: ObjectId, userId: ObjectId, requestBody: Partial<UserConfigurationInput>, options?: OptionsBase): Promise<AffectedRecords>;
|
|
126
|
-
/**
|
|
127
|
-
* Delete fields from a patient configuration for a group of a user.
|
|
128
|
-
*
|
|
129
|
-
* Permission | Scope | Effect
|
|
130
|
-
* - | - | -
|
|
131
|
-
* `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
|
|
132
|
-
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
|
|
133
|
-
* `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
|
|
134
|
-
* @param groupId The id of the targeted group
|
|
135
|
-
* @param userId The id of the targeted user
|
|
136
|
-
* @param requestBody the list of fields to remove
|
|
137
|
-
* @returns AffectedRecords
|
|
138
|
-
*/
|
|
139
|
-
removeFields(groupId: ObjectId, userId: ObjectId, requestBody: {
|
|
140
|
-
fields: Array<string>;
|
|
141
|
-
}, options?: OptionsBase): Promise<AffectedRecords>;
|
|
142
|
-
}
|
|
143
|
-
export interface ConfigurationsStaffService {
|
|
144
|
-
/**
|
|
145
|
-
* Update a staff configuration for a group of a user.
|
|
146
|
-
*
|
|
147
|
-
* Permission | Scope | Effect
|
|
148
|
-
* - | - | -
|
|
149
|
-
* `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
|
|
150
|
-
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
|
|
151
|
-
* `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
|
|
152
|
-
* @param groupId The id of the targeted group
|
|
153
|
-
* @param userId The id of the targeted user
|
|
154
|
-
* @param requestBody UserConfigurationInput
|
|
155
|
-
* @returns AffectedRecords
|
|
156
|
-
*/
|
|
157
|
-
update(groupId: ObjectId, userId: ObjectId, requestBody: Partial<UserConfigurationInput>, options?: OptionsBase): Promise<AffectedRecords>;
|
|
158
|
-
/**
|
|
159
|
-
* Delete fields from a staff configuration for a group of a user.
|
|
160
|
-
*
|
|
161
|
-
* Permission | Scope | Effect
|
|
162
|
-
* - | - | -
|
|
163
|
-
* `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
|
|
164
|
-
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
|
|
165
|
-
* `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
|
|
166
|
-
* @param groupId The id of the targeted group
|
|
167
|
-
* @param userId The id of the targeted user
|
|
168
|
-
* @param requestBody the list of fields to remove
|
|
169
|
-
* @returns AffectedRecords
|
|
170
|
-
*/
|
|
171
|
-
removeFields(groupId: ObjectId, userId: ObjectId, requestBody: {
|
|
172
|
-
fields: Array<string>;
|
|
173
|
-
}, options?: OptionsBase): Promise<AffectedRecords>;
|
|
174
|
-
}
|
|
175
|
-
export interface ConfigurationsUsersService {
|
|
176
|
-
/**
|
|
177
|
-
* Get a user configuration
|
|
178
|
-
*
|
|
179
|
-
* Permission | Scope | Effect
|
|
180
|
-
* - | - | -
|
|
181
|
-
* none | | View your own configuration
|
|
182
|
-
* `VIEW_PATIENT_CONFIGURATIONS` | `staff enlistment` | For patients of the group, view the patient enlistment configuration of the group
|
|
183
|
-
* `VIEW_STAFF_CONFIGURATIONS` | `staff enlistment` | For staff of the group, view the staff enlistment configuration of the group
|
|
184
|
-
* `VIEW_CONFIGURATIONS` | `staff enlistment` | view the patient enlistment configuration of the group
|
|
185
|
-
* `VIEW_CONFIGURATIONS` | `global` | View any user its full configuration
|
|
186
|
-
* @param userId The id of the targeted user
|
|
187
|
-
* @returns UserConfiguration
|
|
188
|
-
*/
|
|
189
|
-
get(userId: ObjectId, options?: OptionsBase): Promise<UserConfiguration>;
|
|
190
|
-
/**
|
|
191
|
-
* Update a user configuration
|
|
192
|
-
*
|
|
193
|
-
* Only the `data` content
|
|
194
|
-
*
|
|
195
|
-
* Permission | Scope | Effect
|
|
196
|
-
* - | - | -
|
|
197
|
-
* `UPDATE_CONFIGURATIONS` | `global` | Update any user configuration
|
|
198
|
-
* none | | Update your own configuration
|
|
199
|
-
* @param userId The id of the targeted user
|
|
200
|
-
* @param requestBody UserConfigurationInput
|
|
201
|
-
* @param rql Add filters to the requested list.
|
|
202
|
-
* @returns AffectedRecords
|
|
203
|
-
*/
|
|
204
|
-
update(userId: ObjectId, requestBody: Partial<UserConfigurationInput>, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
205
|
-
/**
|
|
206
|
-
* Delete fields from a user configuration
|
|
207
|
-
*
|
|
208
|
-
* Only from the `data` field
|
|
209
|
-
*
|
|
210
|
-
* Permission | Scope | Effect
|
|
211
|
-
* - | - | -
|
|
212
|
-
* `UPDATE_CONFIGURATIONS` | `global` | Update any user configuration
|
|
213
|
-
* none | | Update your own configuration
|
|
214
|
-
* @param userId The id of the targeted user
|
|
215
|
-
* @param requestBody the list of fields to remove
|
|
216
|
-
* @param rql Add filters to the requested list
|
|
217
|
-
* @returns AffectedRecords
|
|
218
|
-
*/
|
|
219
|
-
removeFields(userId: ObjectId, requestBody: {
|
|
220
|
-
fields: Array<string>;
|
|
221
|
-
}, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
222
|
-
}
|
|
1
|
+
import { Entity, Timestamps, ObjectId, AffectedRecords, OptionsBase, OptionsWithRql } from '../types';
|
|
2
|
+
export declare type Configuration = Record<string, any>;
|
|
3
|
+
export interface GeneralConfigurationInput {
|
|
4
|
+
data: Configuration;
|
|
5
|
+
staffConfiguration: Configuration;
|
|
6
|
+
patientConfiguration: Configuration;
|
|
7
|
+
groupConfiguration?: Configuration;
|
|
8
|
+
userConfiguration?: Configuration;
|
|
9
|
+
}
|
|
10
|
+
export declare type GeneralConfiguration = GeneralConfigurationInput & Entity & Timestamps;
|
|
11
|
+
export interface GroupConfigurationInput {
|
|
12
|
+
data?: Configuration;
|
|
13
|
+
staffConfiguration?: Configuration;
|
|
14
|
+
patientConfiguration?: Configuration;
|
|
15
|
+
}
|
|
16
|
+
export declare type GroupConfiguration = GroupConfigurationInput & Entity & Timestamps;
|
|
17
|
+
export interface UserConfigurationInput {
|
|
18
|
+
data: Configuration;
|
|
19
|
+
}
|
|
20
|
+
export interface UserEnlistments {
|
|
21
|
+
staffConfigurations?: Array<EnlistmentConfiguration>;
|
|
22
|
+
patientConfigurations?: Array<EnlistmentConfiguration>;
|
|
23
|
+
}
|
|
24
|
+
export interface EnlistmentConfiguration {
|
|
25
|
+
groupId: ObjectId;
|
|
26
|
+
data: Configuration;
|
|
27
|
+
}
|
|
28
|
+
export declare type UserConfiguration = UserConfigurationInput & UserEnlistments & Entity & Timestamps;
|
|
29
|
+
export interface ConfigurationsGeneralService {
|
|
30
|
+
/**
|
|
31
|
+
* View the general configuration.
|
|
32
|
+
*
|
|
33
|
+
* Permission | Scope | Effect
|
|
34
|
+
* - | - | -
|
|
35
|
+
* none | | Everyone can use this endpoint
|
|
36
|
+
* @returns GeneralConfiguration
|
|
37
|
+
*/
|
|
38
|
+
get(options?: OptionsBase): Promise<GeneralConfiguration>;
|
|
39
|
+
/**
|
|
40
|
+
* Update the general configuration
|
|
41
|
+
*
|
|
42
|
+
* Permission | Scope | Effect
|
|
43
|
+
* - | - | -
|
|
44
|
+
* `UPDATE_CONFIGURATIONS` | `global` | Required for this endpoint
|
|
45
|
+
* @param requestBody GeneralConfigurationInput
|
|
46
|
+
* @param rql Add filters to the requested list.
|
|
47
|
+
* @returns AffectedRecords
|
|
48
|
+
*/
|
|
49
|
+
update(requestBody: GeneralConfigurationInput, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
50
|
+
/**
|
|
51
|
+
* Delete fields from the general configuration.
|
|
52
|
+
*
|
|
53
|
+
* Permission | Scope | Effect
|
|
54
|
+
* - | - | -
|
|
55
|
+
* `UPDATE_CONFIGURATIONS` | `global` | Required for this endpoint
|
|
56
|
+
* @param requestBody list of fields to remove
|
|
57
|
+
* @param rql Add filters to the requested list.
|
|
58
|
+
* @returns AffectedRecords
|
|
59
|
+
*/
|
|
60
|
+
removeFields(requestBody: {
|
|
61
|
+
fields: Array<string>;
|
|
62
|
+
}, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
63
|
+
}
|
|
64
|
+
export interface ConfigurationsGroupsService {
|
|
65
|
+
/**
|
|
66
|
+
* View a group configuration
|
|
67
|
+
*
|
|
68
|
+
* Permission | Scope | Effect
|
|
69
|
+
* - | - | -
|
|
70
|
+
* `VIEW_PATIENT_CONFIGURATIONS` | `staff enlistment` | View the group its patient configuration
|
|
71
|
+
* `VIEW_STAFF_CONFIGURATIONS` | `staff enlistment` | View the group its staff configuration
|
|
72
|
+
* `VIEW_CONFIGURATIONS` | `staff enlistment` | View the group its full configuration
|
|
73
|
+
* `VIEW_CONFIGURATIONS` | `global` | View any group its full configuration
|
|
74
|
+
* @param groupId The id of the targeted group
|
|
75
|
+
* @returns GroupConfiguration
|
|
76
|
+
*/
|
|
77
|
+
get(groupId: ObjectId, options?: OptionsBase): Promise<GroupConfiguration>;
|
|
78
|
+
/**
|
|
79
|
+
* Update a group configuration.
|
|
80
|
+
*
|
|
81
|
+
* Permission | Scope | Effect
|
|
82
|
+
* - | - | -
|
|
83
|
+
* `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | Update the group its patient configuration
|
|
84
|
+
* `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | Update the group its staff configuration
|
|
85
|
+
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | Update the group its full configuration
|
|
86
|
+
* `UPDATE_CONFIGURATIONS` | `global` | Update any group its full configuration
|
|
87
|
+
* @param groupId The id of the targeted group
|
|
88
|
+
* @param requestBody GroupConfigurationInput
|
|
89
|
+
* @param rql Add filters to the requested list.
|
|
90
|
+
* @returns AffectedRecords
|
|
91
|
+
*/
|
|
92
|
+
update(groupId: ObjectId, requestBody: GroupConfigurationInput, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
93
|
+
/**
|
|
94
|
+
* Delete fields from a group configuration.
|
|
95
|
+
*
|
|
96
|
+
* Permission | Scope | Effect
|
|
97
|
+
* - | - | -
|
|
98
|
+
* `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | Update the group its patient configuration
|
|
99
|
+
* `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | Update the group its staff configuration
|
|
100
|
+
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | Update the group its full configuration
|
|
101
|
+
* `UPDATE_CONFIGURATIONS` | `global` | Update any group its full configuration
|
|
102
|
+
* @param groupId The id of the targeted group
|
|
103
|
+
* @param requestBody the list of fields to remove
|
|
104
|
+
* @param rql Add filters to the requested list.
|
|
105
|
+
* @returns AffectedRecords
|
|
106
|
+
*/
|
|
107
|
+
removeFields(groupId: ObjectId, requestBody: {
|
|
108
|
+
fields: Array<string>;
|
|
109
|
+
}, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
110
|
+
}
|
|
111
|
+
export interface ConfigurationsPatientsService {
|
|
112
|
+
/**
|
|
113
|
+
* Update a patient configuration for a group of a user.
|
|
114
|
+
*
|
|
115
|
+
* Permission | Scope | Effect
|
|
116
|
+
* - | - | -
|
|
117
|
+
* `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
|
|
118
|
+
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
|
|
119
|
+
* `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
|
|
120
|
+
* @param groupId The id of the targeted group
|
|
121
|
+
* @param userId The id of the targeted user
|
|
122
|
+
* @param requestBody UserConfigurationInput
|
|
123
|
+
* @returns AffectedRecords
|
|
124
|
+
*/
|
|
125
|
+
update(groupId: ObjectId, userId: ObjectId, requestBody: Partial<UserConfigurationInput>, options?: OptionsBase): Promise<AffectedRecords>;
|
|
126
|
+
/**
|
|
127
|
+
* Delete fields from a patient configuration for a group of a user.
|
|
128
|
+
*
|
|
129
|
+
* Permission | Scope | Effect
|
|
130
|
+
* - | - | -
|
|
131
|
+
* `UPDATE_PATIENT_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
|
|
132
|
+
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | For patients of the group, update the patient enlistment configuration of the group
|
|
133
|
+
* `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
|
|
134
|
+
* @param groupId The id of the targeted group
|
|
135
|
+
* @param userId The id of the targeted user
|
|
136
|
+
* @param requestBody the list of fields to remove
|
|
137
|
+
* @returns AffectedRecords
|
|
138
|
+
*/
|
|
139
|
+
removeFields(groupId: ObjectId, userId: ObjectId, requestBody: {
|
|
140
|
+
fields: Array<string>;
|
|
141
|
+
}, options?: OptionsBase): Promise<AffectedRecords>;
|
|
142
|
+
}
|
|
143
|
+
export interface ConfigurationsStaffService {
|
|
144
|
+
/**
|
|
145
|
+
* Update a staff configuration for a group of a user.
|
|
146
|
+
*
|
|
147
|
+
* Permission | Scope | Effect
|
|
148
|
+
* - | - | -
|
|
149
|
+
* `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
|
|
150
|
+
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
|
|
151
|
+
* `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
|
|
152
|
+
* @param groupId The id of the targeted group
|
|
153
|
+
* @param userId The id of the targeted user
|
|
154
|
+
* @param requestBody UserConfigurationInput
|
|
155
|
+
* @returns AffectedRecords
|
|
156
|
+
*/
|
|
157
|
+
update(groupId: ObjectId, userId: ObjectId, requestBody: Partial<UserConfigurationInput>, options?: OptionsBase): Promise<AffectedRecords>;
|
|
158
|
+
/**
|
|
159
|
+
* Delete fields from a staff configuration for a group of a user.
|
|
160
|
+
*
|
|
161
|
+
* Permission | Scope | Effect
|
|
162
|
+
* - | - | -
|
|
163
|
+
* `UPDATE_STAFF_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
|
|
164
|
+
* `UPDATE_CONFIGURATIONS` | `staff enlistment` | For staff of the group, update the staff enlistment configuration of the group
|
|
165
|
+
* `UPDATE_CONFIGURATIONS` | `global` | Update any user its staff configuration
|
|
166
|
+
* @param groupId The id of the targeted group
|
|
167
|
+
* @param userId The id of the targeted user
|
|
168
|
+
* @param requestBody the list of fields to remove
|
|
169
|
+
* @returns AffectedRecords
|
|
170
|
+
*/
|
|
171
|
+
removeFields(groupId: ObjectId, userId: ObjectId, requestBody: {
|
|
172
|
+
fields: Array<string>;
|
|
173
|
+
}, options?: OptionsBase): Promise<AffectedRecords>;
|
|
174
|
+
}
|
|
175
|
+
export interface ConfigurationsUsersService {
|
|
176
|
+
/**
|
|
177
|
+
* Get a user configuration
|
|
178
|
+
*
|
|
179
|
+
* Permission | Scope | Effect
|
|
180
|
+
* - | - | -
|
|
181
|
+
* none | | View your own configuration
|
|
182
|
+
* `VIEW_PATIENT_CONFIGURATIONS` | `staff enlistment` | For patients of the group, view the patient enlistment configuration of the group
|
|
183
|
+
* `VIEW_STAFF_CONFIGURATIONS` | `staff enlistment` | For staff of the group, view the staff enlistment configuration of the group
|
|
184
|
+
* `VIEW_CONFIGURATIONS` | `staff enlistment` | view the patient enlistment configuration of the group
|
|
185
|
+
* `VIEW_CONFIGURATIONS` | `global` | View any user its full configuration
|
|
186
|
+
* @param userId The id of the targeted user
|
|
187
|
+
* @returns UserConfiguration
|
|
188
|
+
*/
|
|
189
|
+
get(userId: ObjectId, options?: OptionsBase): Promise<UserConfiguration>;
|
|
190
|
+
/**
|
|
191
|
+
* Update a user configuration
|
|
192
|
+
*
|
|
193
|
+
* Only the `data` content
|
|
194
|
+
*
|
|
195
|
+
* Permission | Scope | Effect
|
|
196
|
+
* - | - | -
|
|
197
|
+
* `UPDATE_CONFIGURATIONS` | `global` | Update any user configuration
|
|
198
|
+
* none | | Update your own configuration
|
|
199
|
+
* @param userId The id of the targeted user
|
|
200
|
+
* @param requestBody UserConfigurationInput
|
|
201
|
+
* @param rql Add filters to the requested list.
|
|
202
|
+
* @returns AffectedRecords
|
|
203
|
+
*/
|
|
204
|
+
update(userId: ObjectId, requestBody: Partial<UserConfigurationInput>, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
205
|
+
/**
|
|
206
|
+
* Delete fields from a user configuration
|
|
207
|
+
*
|
|
208
|
+
* Only from the `data` field
|
|
209
|
+
*
|
|
210
|
+
* Permission | Scope | Effect
|
|
211
|
+
* - | - | -
|
|
212
|
+
* `UPDATE_CONFIGURATIONS` | `global` | Update any user configuration
|
|
213
|
+
* none | | Update your own configuration
|
|
214
|
+
* @param userId The id of the targeted user
|
|
215
|
+
* @param requestBody the list of fields to remove
|
|
216
|
+
* @param rql Add filters to the requested list
|
|
217
|
+
* @returns AffectedRecords
|
|
218
|
+
*/
|
|
219
|
+
removeFields(userId: ObjectId, requestBody: {
|
|
220
|
+
fields: Array<string>;
|
|
221
|
+
}, options?: OptionsWithRql): Promise<AffectedRecords>;
|
|
222
|
+
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { HttpInstance } from '../../types';
|
|
2
|
-
import { HttpClient } from '../http-client';
|
|
3
|
-
import type { ConfigurationsUsersService } from './types';
|
|
4
|
-
declare const _default: (client: HttpClient, httpAuth: HttpInstance) => ConfigurationsUsersService;
|
|
5
|
-
export default _default;
|
|
1
|
+
import type { HttpInstance } from '../../types';
|
|
2
|
+
import { HttpClient } from '../http-client';
|
|
3
|
+
import type { ConfigurationsUsersService } from './types';
|
|
4
|
+
declare const _default: (client: HttpClient, httpAuth: HttpInstance) => ConfigurationsUsersService;
|
|
5
|
+
export default _default;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { HttpInstance } from '../../types';
|
|
2
|
-
import { HttpClient } from '../http-client';
|
|
3
|
-
import { DataCommentsService } from './types';
|
|
4
|
-
declare const _default: (client: HttpClient, httpAuth: HttpInstance) => DataCommentsService;
|
|
5
|
-
export default _default;
|
|
1
|
+
import type { HttpInstance } from '../../types';
|
|
2
|
+
import { HttpClient } from '../http-client';
|
|
3
|
+
import { DataCommentsService } from './types';
|
|
4
|
+
declare const _default: (client: HttpClient, httpAuth: HttpInstance) => DataCommentsService;
|
|
5
|
+
export default _default;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { HttpInstance } from '../../types';
|
|
2
|
-
import { HttpClient } from '../http-client';
|
|
3
|
-
import { DataDocumentsService } from './types';
|
|
4
|
-
declare const _default: (client: HttpClient, httpAuth: HttpInstance) => DataDocumentsService;
|
|
5
|
-
export default _default;
|
|
1
|
+
import type { HttpInstance } from '../../types';
|
|
2
|
+
import { HttpClient } from '../http-client';
|
|
3
|
+
import { DataDocumentsService } from './types';
|
|
4
|
+
declare const _default: (client: HttpClient, httpAuth: HttpInstance) => DataDocumentsService;
|
|
5
|
+
export default _default;
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import type { HttpInstance } from '../../types';
|
|
2
|
-
import infrastructure from './infrastructure';
|
|
3
|
-
import { DataCommentsService, DataDocumentsService, DataIndexesService, DataPropertiesService, DataSchemasService, DataStatusesService, DataTransitionsService } from './types';
|
|
4
|
-
export declare type DataService = ReturnType<typeof infrastructure> & {
|
|
5
|
-
schemas: DataSchemasService;
|
|
6
|
-
indexes: DataIndexesService;
|
|
7
|
-
statuses: DataStatusesService;
|
|
8
|
-
properties: DataPropertiesService;
|
|
9
|
-
comments: DataCommentsService;
|
|
10
|
-
documents: DataDocumentsService;
|
|
11
|
-
transitions: DataTransitionsService;
|
|
12
|
-
};
|
|
13
|
-
export declare const dataService: (httpWithAuth: HttpInstance) => DataService;
|
|
1
|
+
import type { HttpInstance } from '../../types';
|
|
2
|
+
import infrastructure from './infrastructure';
|
|
3
|
+
import { DataCommentsService, DataDocumentsService, DataIndexesService, DataPropertiesService, DataSchemasService, DataStatusesService, DataTransitionsService } from './types';
|
|
4
|
+
export declare type DataService = ReturnType<typeof infrastructure> & {
|
|
5
|
+
schemas: DataSchemasService;
|
|
6
|
+
indexes: DataIndexesService;
|
|
7
|
+
statuses: DataStatusesService;
|
|
8
|
+
properties: DataPropertiesService;
|
|
9
|
+
comments: DataCommentsService;
|
|
10
|
+
documents: DataDocumentsService;
|
|
11
|
+
transitions: DataTransitionsService;
|
|
12
|
+
};
|
|
13
|
+
export declare const dataService: (httpWithAuth: HttpInstance) => DataService;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { HttpInstance } from '../../types';
|
|
2
|
-
import { HttpClient } from '../http-client';
|
|
3
|
-
import { DataIndexesService } from './types';
|
|
4
|
-
declare const _default: (client: HttpClient, httpAuth: HttpInstance) => DataIndexesService;
|
|
5
|
-
export default _default;
|
|
1
|
+
import type { HttpInstance } from '../../types';
|
|
2
|
+
import { HttpClient } from '../http-client';
|
|
3
|
+
import { DataIndexesService } from './types';
|
|
4
|
+
declare const _default: (client: HttpClient, httpAuth: HttpInstance) => DataIndexesService;
|
|
5
|
+
export default _default;
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import type { HttpInstance } from '../../types';
|
|
2
|
-
declare const _default: (client: any, http: HttpInstance) => {
|
|
3
|
-
/**
|
|
4
|
-
* Perform a health check
|
|
5
|
-
* @returns true if the service is available
|
|
6
|
-
* @throws {ServerError}
|
|
7
|
-
*/
|
|
8
|
-
health(): Promise<boolean>;
|
|
9
|
-
};
|
|
10
|
-
export default _default;
|
|
1
|
+
import type { HttpInstance } from '../../types';
|
|
2
|
+
declare const _default: (client: any, http: HttpInstance) => {
|
|
3
|
+
/**
|
|
4
|
+
* Perform a health check
|
|
5
|
+
* @returns true if the service is available
|
|
6
|
+
* @throws {ServerError}
|
|
7
|
+
*/
|
|
8
|
+
health(): Promise<boolean>;
|
|
9
|
+
};
|
|
10
|
+
export default _default;
|