memori-client 0.1.6 → 0.1.9

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 (43) hide show
  1. checksums.yaml +4 -4
  2. data/doc/MemoriClient::Backend::V1::Asset.md +117 -0
  3. data/doc/MemoriClient::Backend::V2::ActionLog.md +37 -0
  4. data/doc/MemoriClient::Backend::V2::Analysis.md +39 -0
  5. data/doc/MemoriClient::Backend::V2::Asset.md +102 -0
  6. data/doc/MemoriClient::Backend::V2::Badge.md +64 -0
  7. data/doc/MemoriClient::Backend::V2::CompletionConfig.md +115 -0
  8. data/doc/MemoriClient::Backend::V2::ConsumptionLog.md +57 -0
  9. data/doc/MemoriClient::Backend::V2::ImportExport.md +180 -0
  10. data/doc/MemoriClient::Backend::V2::Integration.md +117 -0
  11. data/doc/MemoriClient::Backend::V2::Invitation.md +179 -0
  12. data/doc/MemoriClient::Backend::V2::Memori.md +394 -0
  13. data/doc/MemoriClient::Backend::V2::MemoriList.md +147 -0
  14. data/doc/MemoriClient::Backend::V2::Notification.md +31 -0
  15. data/doc/MemoriClient::Backend::V2::Process.md +64 -0
  16. data/doc/MemoriClient::Backend::V2::Tenant.md +142 -0
  17. data/doc/MemoriClient::Backend::V2::User.md +647 -0
  18. data/doc/MemoriClient::Engine::V2::ChatLog.md +82 -0
  19. data/doc/MemoriClient::Engine::V2::ContextVar.md +46 -0
  20. data/doc/MemoriClient::Engine::V2::CorrelationPair.md +72 -0
  21. data/doc/MemoriClient::Engine::V2::CustomDictionary.md +108 -0
  22. data/doc/MemoriClient::Engine::V2::Dialog.md +152 -0
  23. data/doc/MemoriClient::Engine::V2::EventLog.md +85 -0
  24. data/doc/MemoriClient::Engine::V2::ExpertReference.md +116 -0
  25. data/doc/MemoriClient::Engine::V2::Function.md +140 -0
  26. data/doc/MemoriClient::Engine::V2::Intent.md +225 -0
  27. data/doc/MemoriClient::Engine::V2::LocalizationKey.md +105 -0
  28. data/doc/MemoriClient::Engine::V2::Medium.md +118 -0
  29. data/doc/MemoriClient::Engine::V2::Memory.md +244 -0
  30. data/doc/MemoriClient::Engine::V2::NLP.md +100 -0
  31. data/doc/MemoriClient::Engine::V2::Person.md +114 -0
  32. data/doc/MemoriClient::Engine::V2::Search.md +151 -0
  33. data/doc/MemoriClient::Engine::V2::Session.md +55 -0
  34. data/doc/MemoriClient::Engine::V2::Stat.md +18 -0
  35. data/doc/MemoriClient::Engine::V2::Topic.md +80 -0
  36. data/doc/MemoriClient::Engine::V2::UnansweredQuestion.md +75 -0
  37. data/doc/MemoriClient::Engine::V2::User.md +140 -0
  38. data/doc/MemoriClient::Engine::V2::WebHook.md +67 -0
  39. data/lib/memori_client/railtie.rb +12 -0
  40. data/lib/memori_client/utils/rails.rb +54 -0
  41. data/lib/memori_client.rb +7 -0
  42. data/lib/tasks/memori_client.rake +15 -0
  43. metadata +42 -2
data/doc/MemoriClient::Backend::V2::User.md ADDED
@@ -0,0 +1,647 @@
1
+ # Module `MemoriClient::Backend::V2::User`
2
+
3
+ ## login
4
+
5
+ Summary:
6
+ Tries a login with the specified credentials and returns a login token if successful.
7
+
8
+ Signature: `login(payload: {})`
9
+ Invocation: `MemoriClient::Backend::V2::User.login(payload: {})`
10
+
11
+ HTTP API: POST /api/v2/Login`
12
+
13
+ Parameters:
14
+
15
+ - `payload`: **Hash** request payload. optional
16
+ - `payload.tenant`: **String** . optional
17
+ - `payload.userID`: **String** . optional
18
+ - `payload.userName`: **String** . optional
19
+ - `payload.password`: **String** . optional
20
+ - `payload.newPassword`: **String** . optional
21
+ - `payload.eMail`: **String** . optional
22
+ - `payload.avatarURL`: **String** . optional
23
+ - `payload.avatar3DURL`: **String** . optional
24
+ - `payload.avatar3DURLType`: **String** . optional
25
+ - `payload.dontSendInvitationEmail`: **Boolean** . optional
26
+ - `payload.referral`: **String** . optional
27
+ - `payload.couponCode`: **String** . optional
28
+ - `payload.newsletterSubscribed`: **Boolean** . optional
29
+ - `payload.notificationPrefs`: **Array** . optional
30
+ - `payload.admin`: **Boolean** . optional
31
+ - `payload.superAdmin`: **Boolean** . optional
32
+ - `payload.numMemori`: **Integer** . optional
33
+ - `payload.maxMemori`: **Integer** . optional
34
+ - `payload.monthSessions`: **Integer** . optional
35
+ - `payload.monthValidSessions`: **Integer** . optional
36
+ - `payload.monthDeepThoughtValidSessions`: **Integer** . optional
37
+ - `payload.maxFreeSessions`: **Integer** . optional
38
+ - `payload.nonFreeSessionCost`: **Number** . optional
39
+ - `payload.monthCompletions`: **Integer** . optional
40
+ - `payload.monthDeepThoughtCompletions`: **Integer** . optional
41
+ - `payload.monthImportedSize`: **Integer** . optional
42
+ - `payload.maxCompletions`: **Integer** . optional
43
+ - `payload.maxImportSize`: **Integer** . optional
44
+ - `payload.paying`: **Boolean** . optional
45
+ - `payload.enableMemoriCreation`: **Boolean** . optional
46
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
47
+ - `payload.enableDCMIntegration`: **Boolean** . optional
48
+ - `payload.enableBadges`: **Boolean** . optional
49
+ - `payload.enableDeepThought`: **Boolean** . optional
50
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
51
+ - `payload.birthDate`: **String** . optional
52
+ - `payload.age`: **Integer** . optional
53
+ - `payload.tnCAndPPAccepted`: **Boolean** . optional
54
+ - `payload.tnCAndPPAcceptanceDate`: **String** . optional
55
+ - `payload.pAndCUAccepted`: **Boolean** . optional
56
+ - `payload.pAndCUAcceptanceDate`: **String** . optional
57
+ - `payload.verificationCode`: **String** . optional
58
+ - `payload.flowID`: **String** . optional
59
+ - `payload.creationTimestamp`: **String** . optional
60
+ - `payload.lastChangeTimestamp`: **String** . optional
61
+
62
+ ## logout
63
+
64
+ Summary:
65
+ Logs out the User.
66
+
67
+ Signature: `logout(strToken:)`
68
+ Invocation: `MemoriClient::Backend::V2::User.logout(strToken:)`
69
+
70
+ HTTP API: POST /api/v2/Logout/{strToken}`
71
+
72
+ Parameters:
73
+
74
+ - `strToken`: **string** The login token. required
75
+
76
+ ## get_user
77
+
78
+ Summary:
79
+ Gets the details of the currently logged in User object.
80
+
81
+ Signature: `get_user(strToken:)`
82
+ Invocation: `MemoriClient::Backend::V2::User.get_user(strToken:)`
83
+
84
+ HTTP API: GET /api/v2/User/{strToken}`
85
+
86
+ Parameters:
87
+
88
+ - `strToken`: **string** The login token. required
89
+
90
+ ## create_user
91
+
92
+ Summary:
93
+ Creates a new user.
94
+
95
+ Signature: `create_user(strToken:, payload: {})`
96
+ Invocation: `MemoriClient::Backend::V2::User.create_user(strToken:, payload: {})`
97
+
98
+ HTTP API: POST /api/v2/User/{strToken}`
99
+
100
+ Parameters:
101
+
102
+ - `strToken`: **string** The login token. required
103
+ - `payload`: **Hash** request payload. optional
104
+ - `payload.tenant`: **String** . optional
105
+ - `payload.userID`: **String** . optional
106
+ - `payload.userName`: **String** . optional
107
+ - `payload.password`: **String** . optional
108
+ - `payload.newPassword`: **String** . optional
109
+ - `payload.eMail`: **String** . optional
110
+ - `payload.avatarURL`: **String** . optional
111
+ - `payload.avatar3DURL`: **String** . optional
112
+ - `payload.avatar3DURLType`: **String** . optional
113
+ - `payload.dontSendInvitationEmail`: **Boolean** . optional
114
+ - `payload.referral`: **String** . optional
115
+ - `payload.couponCode`: **String** . optional
116
+ - `payload.newsletterSubscribed`: **Boolean** . optional
117
+ - `payload.notificationPrefs`: **Array** . optional
118
+ - `payload.admin`: **Boolean** . optional
119
+ - `payload.superAdmin`: **Boolean** . optional
120
+ - `payload.numMemori`: **Integer** . optional
121
+ - `payload.maxMemori`: **Integer** . optional
122
+ - `payload.monthSessions`: **Integer** . optional
123
+ - `payload.monthValidSessions`: **Integer** . optional
124
+ - `payload.monthDeepThoughtValidSessions`: **Integer** . optional
125
+ - `payload.maxFreeSessions`: **Integer** . optional
126
+ - `payload.nonFreeSessionCost`: **Number** . optional
127
+ - `payload.monthCompletions`: **Integer** . optional
128
+ - `payload.monthDeepThoughtCompletions`: **Integer** . optional
129
+ - `payload.monthImportedSize`: **Integer** . optional
130
+ - `payload.maxCompletions`: **Integer** . optional
131
+ - `payload.maxImportSize`: **Integer** . optional
132
+ - `payload.paying`: **Boolean** . optional
133
+ - `payload.enableMemoriCreation`: **Boolean** . optional
134
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
135
+ - `payload.enableDCMIntegration`: **Boolean** . optional
136
+ - `payload.enableBadges`: **Boolean** . optional
137
+ - `payload.enableDeepThought`: **Boolean** . optional
138
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
139
+ - `payload.birthDate`: **String** . optional
140
+ - `payload.age`: **Integer** . optional
141
+ - `payload.tnCAndPPAccepted`: **Boolean** . optional
142
+ - `payload.tnCAndPPAcceptanceDate`: **String** . optional
143
+ - `payload.pAndCUAccepted`: **Boolean** . optional
144
+ - `payload.pAndCUAcceptanceDate`: **String** . optional
145
+ - `payload.verificationCode`: **String** . optional
146
+ - `payload.flowID`: **String** . optional
147
+ - `payload.creationTimestamp`: **String** . optional
148
+ - `payload.lastChangeTimestamp`: **String** . optional
149
+
150
+ ## get_user_by_id
151
+
152
+ Summary:
153
+ Gets the details of a User object.
154
+
155
+ Signature: `get_user_by_id(strToken:, strUserID:)`
156
+ Invocation: `MemoriClient::Backend::V2::User.get_user_by_id(strToken:, strUserID:)`
157
+
158
+ HTTP API: GET /api/v2/User/{strToken}/{strUserID}`
159
+
160
+ Parameters:
161
+
162
+ - `strToken`: **string** The login token. required
163
+ - `strUserID`: **string** The User object ID. required
164
+
165
+ ## update_user
166
+
167
+ Summary:
168
+ Updates the details of a User object (including its password).
169
+
170
+ Signature: `update_user(strToken:, strUserID:, payload: {})`
171
+ Invocation: `MemoriClient::Backend::V2::User.update_user(strToken:, strUserID:, payload: {})`
172
+
173
+ HTTP API: PATCH /api/v2/User/{strToken}/{strUserID}`
174
+
175
+ Parameters:
176
+
177
+ - `strToken`: **string** The login token. required
178
+ - `strUserID`: **string** The User object ID. required
179
+ - `payload`: **Hash** request payload. optional
180
+ - `payload.tenant`: **String** . optional
181
+ - `payload.userID`: **String** . optional
182
+ - `payload.userName`: **String** . optional
183
+ - `payload.password`: **String** . optional
184
+ - `payload.newPassword`: **String** . optional
185
+ - `payload.eMail`: **String** . optional
186
+ - `payload.avatarURL`: **String** . optional
187
+ - `payload.avatar3DURL`: **String** . optional
188
+ - `payload.avatar3DURLType`: **String** . optional
189
+ - `payload.dontSendInvitationEmail`: **Boolean** . optional
190
+ - `payload.referral`: **String** . optional
191
+ - `payload.couponCode`: **String** . optional
192
+ - `payload.newsletterSubscribed`: **Boolean** . optional
193
+ - `payload.notificationPrefs`: **Array** . optional
194
+ - `payload.admin`: **Boolean** . optional
195
+ - `payload.superAdmin`: **Boolean** . optional
196
+ - `payload.numMemori`: **Integer** . optional
197
+ - `payload.maxMemori`: **Integer** . optional
198
+ - `payload.monthSessions`: **Integer** . optional
199
+ - `payload.monthValidSessions`: **Integer** . optional
200
+ - `payload.monthDeepThoughtValidSessions`: **Integer** . optional
201
+ - `payload.maxFreeSessions`: **Integer** . optional
202
+ - `payload.nonFreeSessionCost`: **Number** . optional
203
+ - `payload.monthCompletions`: **Integer** . optional
204
+ - `payload.monthDeepThoughtCompletions`: **Integer** . optional
205
+ - `payload.monthImportedSize`: **Integer** . optional
206
+ - `payload.maxCompletions`: **Integer** . optional
207
+ - `payload.maxImportSize`: **Integer** . optional
208
+ - `payload.paying`: **Boolean** . optional
209
+ - `payload.enableMemoriCreation`: **Boolean** . optional
210
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
211
+ - `payload.enableDCMIntegration`: **Boolean** . optional
212
+ - `payload.enableBadges`: **Boolean** . optional
213
+ - `payload.enableDeepThought`: **Boolean** . optional
214
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
215
+ - `payload.birthDate`: **String** . optional
216
+ - `payload.age`: **Integer** . optional
217
+ - `payload.tnCAndPPAccepted`: **Boolean** . optional
218
+ - `payload.tnCAndPPAcceptanceDate`: **String** . optional
219
+ - `payload.pAndCUAccepted`: **Boolean** . optional
220
+ - `payload.pAndCUAcceptanceDate`: **String** . optional
221
+ - `payload.verificationCode`: **String** . optional
222
+ - `payload.flowID`: **String** . optional
223
+ - `payload.creationTimestamp`: **String** . optional
224
+ - `payload.lastChangeTimestamp`: **String** . optional
225
+
226
+ ## delete_user
227
+
228
+ Summary:
229
+ Deletes a User object.
230
+
231
+ Signature: `delete_user(strToken:, strUserID:)`
232
+ Invocation: `MemoriClient::Backend::V2::User.delete_user(strToken:, strUserID:)`
233
+
234
+ HTTP API: DELETE /api/v2/User/{strToken}/{strUserID}`
235
+
236
+ Parameters:
237
+
238
+ - `strToken`: **string** The login token. required
239
+ - `strUserID`: **string** The User object ID. required
240
+
241
+ ## list_users
242
+
243
+ Summary:
244
+ Gets a list of all the existing User objects.
245
+
246
+ Signature: `list_users(strToken:)`
247
+ Invocation: `MemoriClient::Backend::V2::User.list_users(strToken:)`
248
+
249
+ HTTP API: GET /api/v2/Users/{strToken}`
250
+
251
+ Parameters:
252
+
253
+ - `strToken`: **string** The login token. required
254
+
255
+ ## list_users_paginated
256
+
257
+ Summary:
258
+ Gets a paginated list of the existing User objects.
259
+
260
+ Signature: `list_users_paginated(strToken:, from:, howMany:)`
261
+ Invocation: `MemoriClient::Backend::V2::User.list_users_paginated(strToken:, from:, howMany:)`
262
+
263
+ HTTP API: GET /api/v2/Users/{strToken}/{from}/{howMany}`
264
+
265
+ Parameters:
266
+
267
+ - `strToken`: **string** The login token. required
268
+ - `from`: **integer** The index of the starting user to get. required
269
+ - `howMany`: **integer** How many users to get. required
270
+
271
+ ## filter_users
272
+
273
+ Summary:
274
+ Returns a paginated list of User objects filtered by the specified criteria
275
+
276
+ Signature: `filter_users(strToken:, payload: {})`
277
+ Invocation: `MemoriClient::Backend::V2::User.filter_users(strToken:, payload: {})`
278
+
279
+ HTTP API: POST /api/v2/FilterUsers/{strToken}`
280
+
281
+ Parameters:
282
+
283
+ - `strToken`: **string** The login token. required
284
+ - `payload`: **Hash** request payload. optional
285
+ - `payload.periodFrom`: **String** . optional
286
+ - `payload.periodTo`: **String** . optional
287
+ - `payload.tenantName`: **String** . optional
288
+ - `payload.text`: **String** . optional
289
+ - `payload.numberOfResults`: **Integer** . optional
290
+ - `payload.startFrom`: **Integer** . optional
291
+ - `payload.orderBy`: **String** . optional
292
+
293
+ ## register_user
294
+
295
+ Summary:
296
+ Registers a new user.
297
+
298
+ Signature: `register_user(payload: {})`
299
+ Invocation: `MemoriClient::Backend::V2::User.register_user(payload: {})`
300
+
301
+ HTTP API: POST /api/v2/User`
302
+
303
+ Parameters:
304
+
305
+ - `payload`: **Hash** request payload. optional
306
+ - `payload.tenant`: **String** . optional
307
+ - `payload.userID`: **String** . optional
308
+ - `payload.userName`: **String** . optional
309
+ - `payload.password`: **String** . optional
310
+ - `payload.newPassword`: **String** . optional
311
+ - `payload.eMail`: **String** . optional
312
+ - `payload.avatarURL`: **String** . optional
313
+ - `payload.avatar3DURL`: **String** . optional
314
+ - `payload.avatar3DURLType`: **String** . optional
315
+ - `payload.dontSendInvitationEmail`: **Boolean** . optional
316
+ - `payload.referral`: **String** . optional
317
+ - `payload.couponCode`: **String** . optional
318
+ - `payload.newsletterSubscribed`: **Boolean** . optional
319
+ - `payload.notificationPrefs`: **Array** . optional
320
+ - `payload.admin`: **Boolean** . optional
321
+ - `payload.superAdmin`: **Boolean** . optional
322
+ - `payload.numMemori`: **Integer** . optional
323
+ - `payload.maxMemori`: **Integer** . optional
324
+ - `payload.monthSessions`: **Integer** . optional
325
+ - `payload.monthValidSessions`: **Integer** . optional
326
+ - `payload.monthDeepThoughtValidSessions`: **Integer** . optional
327
+ - `payload.maxFreeSessions`: **Integer** . optional
328
+ - `payload.nonFreeSessionCost`: **Number** . optional
329
+ - `payload.monthCompletions`: **Integer** . optional
330
+ - `payload.monthDeepThoughtCompletions`: **Integer** . optional
331
+ - `payload.monthImportedSize`: **Integer** . optional
332
+ - `payload.maxCompletions`: **Integer** . optional
333
+ - `payload.maxImportSize`: **Integer** . optional
334
+ - `payload.paying`: **Boolean** . optional
335
+ - `payload.enableMemoriCreation`: **Boolean** . optional
336
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
337
+ - `payload.enableDCMIntegration`: **Boolean** . optional
338
+ - `payload.enableBadges`: **Boolean** . optional
339
+ - `payload.enableDeepThought`: **Boolean** . optional
340
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
341
+ - `payload.birthDate`: **String** . optional
342
+ - `payload.age`: **Integer** . optional
343
+ - `payload.tnCAndPPAccepted`: **Boolean** . optional
344
+ - `payload.tnCAndPPAcceptanceDate`: **String** . optional
345
+ - `payload.pAndCUAccepted`: **Boolean** . optional
346
+ - `payload.pAndCUAcceptanceDate`: **String** . optional
347
+ - `payload.verificationCode`: **String** . optional
348
+ - `payload.flowID`: **String** . optional
349
+ - `payload.creationTimestamp`: **String** . optional
350
+ - `payload.lastChangeTimestamp`: **String** . optional
351
+
352
+ ## resend_verification_code
353
+
354
+ Summary:
355
+ Re-sends the verification code to confirm a pending User registration.
356
+
357
+ Signature: `resend_verification_code(payload: {})`
358
+ Invocation: `MemoriClient::Backend::V2::User.resend_verification_code(payload: {})`
359
+
360
+ HTTP API: POST /api/v2/ResendVerificationCode`
361
+
362
+ Parameters:
363
+
364
+ - `payload`: **Hash** request payload. optional
365
+ - `payload.tenant`: **String** . optional
366
+ - `payload.userID`: **String** . optional
367
+ - `payload.userName`: **String** . optional
368
+ - `payload.password`: **String** . optional
369
+ - `payload.newPassword`: **String** . optional
370
+ - `payload.eMail`: **String** . optional
371
+ - `payload.avatarURL`: **String** . optional
372
+ - `payload.avatar3DURL`: **String** . optional
373
+ - `payload.avatar3DURLType`: **String** . optional
374
+ - `payload.dontSendInvitationEmail`: **Boolean** . optional
375
+ - `payload.referral`: **String** . optional
376
+ - `payload.couponCode`: **String** . optional
377
+ - `payload.newsletterSubscribed`: **Boolean** . optional
378
+ - `payload.notificationPrefs`: **Array** . optional
379
+ - `payload.admin`: **Boolean** . optional
380
+ - `payload.superAdmin`: **Boolean** . optional
381
+ - `payload.numMemori`: **Integer** . optional
382
+ - `payload.maxMemori`: **Integer** . optional
383
+ - `payload.monthSessions`: **Integer** . optional
384
+ - `payload.monthValidSessions`: **Integer** . optional
385
+ - `payload.monthDeepThoughtValidSessions`: **Integer** . optional
386
+ - `payload.maxFreeSessions`: **Integer** . optional
387
+ - `payload.nonFreeSessionCost`: **Number** . optional
388
+ - `payload.monthCompletions`: **Integer** . optional
389
+ - `payload.monthDeepThoughtCompletions`: **Integer** . optional
390
+ - `payload.monthImportedSize`: **Integer** . optional
391
+ - `payload.maxCompletions`: **Integer** . optional
392
+ - `payload.maxImportSize`: **Integer** . optional
393
+ - `payload.paying`: **Boolean** . optional
394
+ - `payload.enableMemoriCreation`: **Boolean** . optional
395
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
396
+ - `payload.enableDCMIntegration`: **Boolean** . optional
397
+ - `payload.enableBadges`: **Boolean** . optional
398
+ - `payload.enableDeepThought`: **Boolean** . optional
399
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
400
+ - `payload.birthDate`: **String** . optional
401
+ - `payload.age`: **Integer** . optional
402
+ - `payload.tnCAndPPAccepted`: **Boolean** . optional
403
+ - `payload.tnCAndPPAcceptanceDate`: **String** . optional
404
+ - `payload.pAndCUAccepted`: **Boolean** . optional
405
+ - `payload.pAndCUAcceptanceDate`: **String** . optional
406
+ - `payload.verificationCode`: **String** . optional
407
+ - `payload.flowID`: **String** . optional
408
+ - `payload.creationTimestamp`: **String** . optional
409
+ - `payload.lastChangeTimestamp`: **String** . optional
410
+
411
+ ## confirm_registration
412
+
413
+ Summary:
414
+ Confirms the registration of a User and performs a Login.
415
+
416
+ Signature: `confirm_registration(payload: {})`
417
+ Invocation: `MemoriClient::Backend::V2::User.confirm_registration(payload: {})`
418
+
419
+ HTTP API: POST /api/v2/UserConfirm`
420
+
421
+ Parameters:
422
+
423
+ - `payload`: **Hash** request payload. optional
424
+ - `payload.tenant`: **String** . optional
425
+ - `payload.userID`: **String** . optional
426
+ - `payload.userName`: **String** . optional
427
+ - `payload.password`: **String** . optional
428
+ - `payload.newPassword`: **String** . optional
429
+ - `payload.eMail`: **String** . optional
430
+ - `payload.avatarURL`: **String** . optional
431
+ - `payload.avatar3DURL`: **String** . optional
432
+ - `payload.avatar3DURLType`: **String** . optional
433
+ - `payload.dontSendInvitationEmail`: **Boolean** . optional
434
+ - `payload.referral`: **String** . optional
435
+ - `payload.couponCode`: **String** . optional
436
+ - `payload.newsletterSubscribed`: **Boolean** . optional
437
+ - `payload.notificationPrefs`: **Array** . optional
438
+ - `payload.admin`: **Boolean** . optional
439
+ - `payload.superAdmin`: **Boolean** . optional
440
+ - `payload.numMemori`: **Integer** . optional
441
+ - `payload.maxMemori`: **Integer** . optional
442
+ - `payload.monthSessions`: **Integer** . optional
443
+ - `payload.monthValidSessions`: **Integer** . optional
444
+ - `payload.monthDeepThoughtValidSessions`: **Integer** . optional
445
+ - `payload.maxFreeSessions`: **Integer** . optional
446
+ - `payload.nonFreeSessionCost`: **Number** . optional
447
+ - `payload.monthCompletions`: **Integer** . optional
448
+ - `payload.monthDeepThoughtCompletions`: **Integer** . optional
449
+ - `payload.monthImportedSize`: **Integer** . optional
450
+ - `payload.maxCompletions`: **Integer** . optional
451
+ - `payload.maxImportSize`: **Integer** . optional
452
+ - `payload.paying`: **Boolean** . optional
453
+ - `payload.enableMemoriCreation`: **Boolean** . optional
454
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
455
+ - `payload.enableDCMIntegration`: **Boolean** . optional
456
+ - `payload.enableBadges`: **Boolean** . optional
457
+ - `payload.enableDeepThought`: **Boolean** . optional
458
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
459
+ - `payload.birthDate`: **String** . optional
460
+ - `payload.age`: **Integer** . optional
461
+ - `payload.tnCAndPPAccepted`: **Boolean** . optional
462
+ - `payload.tnCAndPPAcceptanceDate`: **String** . optional
463
+ - `payload.pAndCUAccepted`: **Boolean** . optional
464
+ - `payload.pAndCUAcceptanceDate`: **String** . optional
465
+ - `payload.verificationCode`: **String** . optional
466
+ - `payload.flowID`: **String** . optional
467
+ - `payload.creationTimestamp`: **String** . optional
468
+ - `payload.lastChangeTimestamp`: **String** . optional
469
+
470
+ ## reset_user_password
471
+
472
+ Summary:
473
+ Resets a User's password.
474
+
475
+ Signature: `reset_user_password(payload: {})`
476
+ Invocation: `MemoriClient::Backend::V2::User.reset_user_password(payload: {})`
477
+
478
+ HTTP API: POST /api/v2/ResetPassword`
479
+
480
+ Parameters:
481
+
482
+ - `payload`: **Hash** request payload. optional
483
+ - `payload.tenant`: **String** . optional
484
+ - `payload.userID`: **String** . optional
485
+ - `payload.userName`: **String** . optional
486
+ - `payload.password`: **String** . optional
487
+ - `payload.newPassword`: **String** . optional
488
+ - `payload.eMail`: **String** . optional
489
+ - `payload.avatarURL`: **String** . optional
490
+ - `payload.avatar3DURL`: **String** . optional
491
+ - `payload.avatar3DURLType`: **String** . optional
492
+ - `payload.dontSendInvitationEmail`: **Boolean** . optional
493
+ - `payload.referral`: **String** . optional
494
+ - `payload.couponCode`: **String** . optional
495
+ - `payload.newsletterSubscribed`: **Boolean** . optional
496
+ - `payload.notificationPrefs`: **Array** . optional
497
+ - `payload.admin`: **Boolean** . optional
498
+ - `payload.superAdmin`: **Boolean** . optional
499
+ - `payload.numMemori`: **Integer** . optional
500
+ - `payload.maxMemori`: **Integer** . optional
501
+ - `payload.monthSessions`: **Integer** . optional
502
+ - `payload.monthValidSessions`: **Integer** . optional
503
+ - `payload.monthDeepThoughtValidSessions`: **Integer** . optional
504
+ - `payload.maxFreeSessions`: **Integer** . optional
505
+ - `payload.nonFreeSessionCost`: **Number** . optional
506
+ - `payload.monthCompletions`: **Integer** . optional
507
+ - `payload.monthDeepThoughtCompletions`: **Integer** . optional
508
+ - `payload.monthImportedSize`: **Integer** . optional
509
+ - `payload.maxCompletions`: **Integer** . optional
510
+ - `payload.maxImportSize`: **Integer** . optional
511
+ - `payload.paying`: **Boolean** . optional
512
+ - `payload.enableMemoriCreation`: **Boolean** . optional
513
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
514
+ - `payload.enableDCMIntegration`: **Boolean** . optional
515
+ - `payload.enableBadges`: **Boolean** . optional
516
+ - `payload.enableDeepThought`: **Boolean** . optional
517
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
518
+ - `payload.birthDate`: **String** . optional
519
+ - `payload.age`: **Integer** . optional
520
+ - `payload.tnCAndPPAccepted`: **Boolean** . optional
521
+ - `payload.tnCAndPPAcceptanceDate`: **String** . optional
522
+ - `payload.pAndCUAccepted`: **Boolean** . optional
523
+ - `payload.pAndCUAcceptanceDate`: **String** . optional
524
+ - `payload.verificationCode`: **String** . optional
525
+ - `payload.flowID`: **String** . optional
526
+ - `payload.creationTimestamp`: **String** . optional
527
+ - `payload.lastChangeTimestamp`: **String** . optional
528
+
529
+ ## confirm_password_reset
530
+
531
+ Summary:
532
+ Confirms the password reset of a User and performs a Login.
533
+
534
+ Signature: `confirm_password_reset(payload: {})`
535
+ Invocation: `MemoriClient::Backend::V2::User.confirm_password_reset(payload: {})`
536
+
537
+ HTTP API: POST /api/v2/ResetConfirm`
538
+
539
+ Parameters:
540
+
541
+ - `payload`: **Hash** request payload. optional
542
+ - `payload.tenant`: **String** . optional
543
+ - `payload.userID`: **String** . optional
544
+ - `payload.userName`: **String** . optional
545
+ - `payload.password`: **String** . optional
546
+ - `payload.newPassword`: **String** . optional
547
+ - `payload.eMail`: **String** . optional
548
+ - `payload.avatarURL`: **String** . optional
549
+ - `payload.avatar3DURL`: **String** . optional
550
+ - `payload.avatar3DURLType`: **String** . optional
551
+ - `payload.dontSendInvitationEmail`: **Boolean** . optional
552
+ - `payload.referral`: **String** . optional
553
+ - `payload.couponCode`: **String** . optional
554
+ - `payload.newsletterSubscribed`: **Boolean** . optional
555
+ - `payload.notificationPrefs`: **Array** . optional
556
+ - `payload.admin`: **Boolean** . optional
557
+ - `payload.superAdmin`: **Boolean** . optional
558
+ - `payload.numMemori`: **Integer** . optional
559
+ - `payload.maxMemori`: **Integer** . optional
560
+ - `payload.monthSessions`: **Integer** . optional
561
+ - `payload.monthValidSessions`: **Integer** . optional
562
+ - `payload.monthDeepThoughtValidSessions`: **Integer** . optional
563
+ - `payload.maxFreeSessions`: **Integer** . optional
564
+ - `payload.nonFreeSessionCost`: **Number** . optional
565
+ - `payload.monthCompletions`: **Integer** . optional
566
+ - `payload.monthDeepThoughtCompletions`: **Integer** . optional
567
+ - `payload.monthImportedSize`: **Integer** . optional
568
+ - `payload.maxCompletions`: **Integer** . optional
569
+ - `payload.maxImportSize`: **Integer** . optional
570
+ - `payload.paying`: **Boolean** . optional
571
+ - `payload.enableMemoriCreation`: **Boolean** . optional
572
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
573
+ - `payload.enableDCMIntegration`: **Boolean** . optional
574
+ - `payload.enableBadges`: **Boolean** . optional
575
+ - `payload.enableDeepThought`: **Boolean** . optional
576
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
577
+ - `payload.birthDate`: **String** . optional
578
+ - `payload.age`: **Integer** . optional
579
+ - `payload.tnCAndPPAccepted`: **Boolean** . optional
580
+ - `payload.tnCAndPPAcceptanceDate`: **String** . optional
581
+ - `payload.pAndCUAccepted`: **Boolean** . optional
582
+ - `payload.pAndCUAcceptanceDate`: **String** . optional
583
+ - `payload.verificationCode`: **String** . optional
584
+ - `payload.flowID`: **String** . optional
585
+ - `payload.creationTimestamp`: **String** . optional
586
+ - `payload.lastChangeTimestamp`: **String** . optional
587
+
588
+ ## recover_user_name
589
+
590
+ Summary:
591
+ Recovers a User's name and sends it to their configured e-mail.
592
+
593
+ Signature: `recover_user_name(payload: {})`
594
+ Invocation: `MemoriClient::Backend::V2::User.recover_user_name(payload: {})`
595
+
596
+ HTTP API: POST /api/v2/RecoverUserName`
597
+
598
+ Parameters:
599
+
600
+ - `payload`: **Hash** request payload. optional
601
+ - `payload.tenant`: **String** . optional
602
+ - `payload.userID`: **String** . optional
603
+ - `payload.userName`: **String** . optional
604
+ - `payload.password`: **String** . optional
605
+ - `payload.newPassword`: **String** . optional
606
+ - `payload.eMail`: **String** . optional
607
+ - `payload.avatarURL`: **String** . optional
608
+ - `payload.avatar3DURL`: **String** . optional
609
+ - `payload.avatar3DURLType`: **String** . optional
610
+ - `payload.dontSendInvitationEmail`: **Boolean** . optional
611
+ - `payload.referral`: **String** . optional
612
+ - `payload.couponCode`: **String** . optional
613
+ - `payload.newsletterSubscribed`: **Boolean** . optional
614
+ - `payload.notificationPrefs`: **Array** . optional
615
+ - `payload.admin`: **Boolean** . optional
616
+ - `payload.superAdmin`: **Boolean** . optional
617
+ - `payload.numMemori`: **Integer** . optional
618
+ - `payload.maxMemori`: **Integer** . optional
619
+ - `payload.monthSessions`: **Integer** . optional
620
+ - `payload.monthValidSessions`: **Integer** . optional
621
+ - `payload.monthDeepThoughtValidSessions`: **Integer** . optional
622
+ - `payload.maxFreeSessions`: **Integer** . optional
623
+ - `payload.nonFreeSessionCost`: **Number** . optional
624
+ - `payload.monthCompletions`: **Integer** . optional
625
+ - `payload.monthDeepThoughtCompletions`: **Integer** . optional
626
+ - `payload.monthImportedSize`: **Integer** . optional
627
+ - `payload.maxCompletions`: **Integer** . optional
628
+ - `payload.maxImportSize`: **Integer** . optional
629
+ - `payload.paying`: **Boolean** . optional
630
+ - `payload.enableMemoriCreation`: **Boolean** . optional
631
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
632
+ - `payload.enableDCMIntegration`: **Boolean** . optional
633
+ - `payload.enableBadges`: **Boolean** . optional
634
+ - `payload.enableDeepThought`: **Boolean** . optional
635
+ - `payload.enableVirtualSpaces`: **Boolean** . optional
636
+ - `payload.birthDate`: **String** . optional
637
+ - `payload.age`: **Integer** . optional
638
+ - `payload.tnCAndPPAccepted`: **Boolean** . optional
639
+ - `payload.tnCAndPPAcceptanceDate`: **String** . optional
640
+ - `payload.pAndCUAccepted`: **Boolean** . optional
641
+ - `payload.pAndCUAcceptanceDate`: **String** . optional
642
+ - `payload.verificationCode`: **String** . optional
643
+ - `payload.flowID`: **String** . optional
644
+ - `payload.creationTimestamp`: **String** . optional
645
+ - `payload.lastChangeTimestamp`: **String** . optional
646
+
647
+