memori-client 0.0.9 → 0.1.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 (44) hide show
  1. checksums.yaml +4 -4
  2. data/lib/memori_client/backend/resource.rb +37 -30
  3. data/lib/memori_client/backend/resources.rb +4 -0
  4. data/lib/memori_client/backend/v1/asset.rb +94 -0
  5. data/lib/memori_client/backend/v2/action_log.rb +11 -7
  6. data/lib/memori_client/backend/v2/asset.rb +33 -13
  7. data/lib/memori_client/backend/v2/badge.rb +60 -0
  8. data/lib/memori_client/backend/v2/consumption_log.rb +16 -10
  9. data/lib/memori_client/backend/v2/import_export.rb +163 -0
  10. data/lib/memori_client/backend/v2/integration.rb +65 -21
  11. data/lib/memori_client/backend/v2/invitation.rb +92 -24
  12. data/lib/memori_client/backend/v2/memori.rb +364 -118
  13. data/lib/memori_client/backend/v2/memori_list.rb +118 -0
  14. data/lib/memori_client/backend/v2/notification.rb +11 -7
  15. data/lib/memori_client/backend/v2/tenant.rb +194 -4
  16. data/lib/memori_client/backend/v2/user.rb +620 -106
  17. data/lib/memori_client/engine/resource.rb +36 -29
  18. data/lib/memori_client/engine/resources.rb +8 -0
  19. data/lib/memori_client/engine/v2/chat_log.rb +21 -13
  20. data/lib/memori_client/engine/v2/completion_log.rb +17 -0
  21. data/lib/memori_client/engine/v2/context_var.rb +16 -10
  22. data/lib/memori_client/engine/v2/correlation_pair.rb +50 -10
  23. data/lib/memori_client/engine/v2/custom_dictionary.rb +113 -0
  24. data/lib/memori_client/engine/v2/dialog.rb +99 -34
  25. data/lib/memori_client/engine/v2/event_log.rb +21 -13
  26. data/lib/memori_client/engine/v2/expert_reference.rb +129 -0
  27. data/lib/memori_client/engine/v2/intent.rb +123 -43
  28. data/lib/memori_client/engine/v2/localization_key.rb +108 -0
  29. data/lib/memori_client/engine/v2/medium.rb +129 -0
  30. data/lib/memori_client/engine/v2/memori.rb +215 -16
  31. data/lib/memori_client/engine/v2/memory.rb +124 -25
  32. data/lib/memori_client/engine/v2/nlp.rb +162 -22
  33. data/lib/memori_client/engine/v2/person.rb +125 -0
  34. data/lib/memori_client/engine/v2/prompted_question.rb +121 -0
  35. data/lib/memori_client/engine/v2/search.rb +67 -10
  36. data/lib/memori_client/engine/v2/session.rb +31 -11
  37. data/lib/memori_client/engine/v2/stat.rb +26 -16
  38. data/lib/memori_client/engine/v2/unanswered_question.rb +56 -10
  39. data/lib/memori_client/engine/v2/user.rb +52 -0
  40. data/lib/memori_client/engine/v2/web_hook.rb +62 -25
  41. data/lib/memori_client/http_client.rb +1 -1
  42. data/lib/memori_client/resource.rb +56 -0
  43. data/lib/memori_client.rb +4 -0
  44. metadata +15 -2
@@ -1,24 +1,18 @@
1
- # Generated on 2023-07-11 06:40:02 +0000
1
+ # Generated on 2024-01-18 17:37:06 +0000
2
2
  class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
3
- # GET /api/v2/Tenant/{tenantName}
4
- # Gets the details of a Tenant object.
5
- # Params list:
6
- # @param [string] tenantName The name of the Tenant. required
7
- # tenant(tenantName:)
8
- def self.tenant(**args)
9
- exec_http_request('get', '/api/v2/Tenant/{tenantName}', args)
10
- end
11
-
12
3
  # POST /api/v2/Login
13
4
  # Tries a login with the specified credentials and returns a login token if successful.
14
5
  # Params list:
15
6
  # @param [object] payload request payload. optional
16
- # @param [string] payload.tenant . optional
7
+ # @param [string] payload.tenant . required
17
8
  # @param [string] payload.userID . optional
18
- # @param [string] payload.userName . optional
19
- # @param [string] payload.password . optional
9
+ # @param [string] payload.userName . required
10
+ # @param [string] payload.password . required
20
11
  # @param [string] payload.newPassword . optional
21
- # @param [string] payload.eMail . optional
12
+ # @param [string] payload.eMail . required
13
+ # @param [string] payload.avatarURL . optional
14
+ # @param [string] payload.avatar3DURL . optional
15
+ # @param [string] payload.avatar3DURLType . optional
22
16
  # @param [boolean] payload.dontSendInvitationEmail . optional
23
17
  # @param [string] payload.referral . optional
24
18
  # @param [string] payload.couponCode . optional
@@ -44,7 +38,9 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
44
38
  # @param [boolean] payload.canEditIntegrations . optional
45
39
  # @param [boolean] payload.canEditDynamicIntents . optional
46
40
  # @param [boolean] payload.canEditMemoriChaining . optional
41
+ # @param [boolean] payload.canEditDCMIntegration . optional
47
42
  # @param [boolean] payload.canRunSnippets . optional
43
+ # @param [boolean] payload.enableBadges . optional
48
44
  # @param [string] payload.birthDate . optional
49
45
  # @param [integer] payload.age . optional
50
46
  # @param [boolean] payload.tnCAndPPAccepted . optional
@@ -53,9 +49,60 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
53
49
  # @param [string] payload.flowID . optional
54
50
  # @param [string] payload.creationTimestamp . optional
55
51
  # @param [string] payload.lastChangeTimestamp . optional
56
- # login()
57
- def self.login(**args)
58
- exec_http_request('post', '/api/v2/Login', args)
52
+ # login(payload: {})
53
+ def self.login(payload: {})
54
+ args = build_arguments(binding)
55
+ payload_keys = [
56
+ 'admin',
57
+ 'age',
58
+ 'avatar3DURL',
59
+ 'avatar3DURLType',
60
+ 'avatarURL',
61
+ 'birthDate',
62
+ 'canAccessAPI',
63
+ 'canCreateMemori',
64
+ 'canEditDCMIntegration',
65
+ 'canEditDynamicIntents',
66
+ 'canEditIntegrations',
67
+ 'canEditMemoriChaining',
68
+ 'canRunSnippets',
69
+ 'couponCode',
70
+ 'creationTimestamp',
71
+ 'defaultCompletionProvider',
72
+ 'defaultCompletionProviderConfig',
73
+ 'dontSendInvitationEmail',
74
+ 'eMail',
75
+ 'enableBadges',
76
+ 'flowID',
77
+ 'lastChangeTimestamp',
78
+ 'maxCompletions',
79
+ 'maxFreeSessions',
80
+ 'maxImportSize',
81
+ 'maxMemori',
82
+ 'monthCompletions',
83
+ 'monthImportedSize',
84
+ 'monthSessions',
85
+ 'monthValidSessions',
86
+ 'newPassword',
87
+ 'newsletterSubscribed',
88
+ 'nonFreeSessionCost',
89
+ 'notificationPrefs',
90
+ 'numMemori',
91
+ 'password',
92
+ 'paying',
93
+ 'referral',
94
+ 'superAdmin',
95
+ 'tenant',
96
+ 'tnCAndPPAcceptanceDate',
97
+ 'tnCAndPPAccepted',
98
+ 'userID',
99
+ 'userName',
100
+ 'verificationCode',
101
+ ]
102
+ payload_required_keys = %w[eMail password tenant userName]
103
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
104
+
105
+ exec_http_request('post', '/api/v2/Login', **args)
59
106
  end
60
107
 
61
108
  # POST /api/v2/Logout/{strToken}
@@ -63,32 +110,37 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
63
110
  # Params list:
64
111
  # @param [string] strToken The login token. required
65
112
  # logout(strToken:)
66
- def self.logout(**args)
67
- exec_http_request('post', '/api/v2/Logout/{strToken}', args)
113
+ def self.logout(strToken:)
114
+ args = build_arguments(binding)
115
+
116
+ exec_http_request('post', '/api/v2/Logout/{strToken}', **args)
68
117
  end
69
118
 
70
- # GET /api/v2/User/{strToken}/{strUserID}
71
- # Gets the details of a User object.
119
+ # GET /api/v2/User/{strToken}
120
+ # Gets the details of the currently logged in User object.
72
121
  # Params list:
73
122
  # @param [string] strToken The login token. required
74
- # @param [string] strUserID The User object ID. required
75
- # user(strToken:, strUserID:)
76
- def self.user(**args)
77
- exec_http_request('get', '/api/v2/User/{strToken}/{strUserID}', args)
123
+ # get_user(strToken:)
124
+ def self.get_user(strToken:)
125
+ args = build_arguments(binding)
126
+
127
+ exec_http_request('get', '/api/v2/User/{strToken}', **args)
78
128
  end
79
129
 
80
- # PATCH /api/v2/User/{strToken}/{strUserID}
81
- # Updates the details of a User object (including its password).
130
+ # POST /api/v2/User/{strToken}
131
+ # Creates a new user.
82
132
  # Params list:
83
133
  # @param [string] strToken The login token. required
84
- # @param [string] strUserID The User object ID. required
85
134
  # @param [object] payload request payload. optional
86
- # @param [string] payload.tenant . optional
135
+ # @param [string] payload.tenant . required
87
136
  # @param [string] payload.userID . optional
88
- # @param [string] payload.userName . optional
89
- # @param [string] payload.password . optional
137
+ # @param [string] payload.userName . required
138
+ # @param [string] payload.password . required
90
139
  # @param [string] payload.newPassword . optional
91
- # @param [string] payload.eMail . optional
140
+ # @param [string] payload.eMail . required
141
+ # @param [string] payload.avatarURL . optional
142
+ # @param [string] payload.avatar3DURL . optional
143
+ # @param [string] payload.avatar3DURLType . optional
92
144
  # @param [boolean] payload.dontSendInvitationEmail . optional
93
145
  # @param [string] payload.referral . optional
94
146
  # @param [string] payload.couponCode . optional
@@ -114,7 +166,9 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
114
166
  # @param [boolean] payload.canEditIntegrations . optional
115
167
  # @param [boolean] payload.canEditDynamicIntents . optional
116
168
  # @param [boolean] payload.canEditMemoriChaining . optional
169
+ # @param [boolean] payload.canEditDCMIntegration . optional
117
170
  # @param [boolean] payload.canRunSnippets . optional
171
+ # @param [boolean] payload.enableBadges . optional
118
172
  # @param [string] payload.birthDate . optional
119
173
  # @param [integer] payload.age . optional
120
174
  # @param [boolean] payload.tnCAndPPAccepted . optional
@@ -123,40 +177,89 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
123
177
  # @param [string] payload.flowID . optional
124
178
  # @param [string] payload.creationTimestamp . optional
125
179
  # @param [string] payload.lastChangeTimestamp . optional
126
- # update_user(strToken:, strUserID:)
127
- def self.update_user(**args)
128
- exec_http_request('patch', '/api/v2/User/{strToken}/{strUserID}', args)
180
+ # create_user(strToken:, payload: {})
181
+ def self.create_user(strToken:, payload: {})
182
+ args = build_arguments(binding)
183
+ payload_keys = [
184
+ 'admin',
185
+ 'age',
186
+ 'avatar3DURL',
187
+ 'avatar3DURLType',
188
+ 'avatarURL',
189
+ 'birthDate',
190
+ 'canAccessAPI',
191
+ 'canCreateMemori',
192
+ 'canEditDCMIntegration',
193
+ 'canEditDynamicIntents',
194
+ 'canEditIntegrations',
195
+ 'canEditMemoriChaining',
196
+ 'canRunSnippets',
197
+ 'couponCode',
198
+ 'creationTimestamp',
199
+ 'defaultCompletionProvider',
200
+ 'defaultCompletionProviderConfig',
201
+ 'dontSendInvitationEmail',
202
+ 'eMail',
203
+ 'enableBadges',
204
+ 'flowID',
205
+ 'lastChangeTimestamp',
206
+ 'maxCompletions',
207
+ 'maxFreeSessions',
208
+ 'maxImportSize',
209
+ 'maxMemori',
210
+ 'monthCompletions',
211
+ 'monthImportedSize',
212
+ 'monthSessions',
213
+ 'monthValidSessions',
214
+ 'newPassword',
215
+ 'newsletterSubscribed',
216
+ 'nonFreeSessionCost',
217
+ 'notificationPrefs',
218
+ 'numMemori',
219
+ 'password',
220
+ 'paying',
221
+ 'referral',
222
+ 'superAdmin',
223
+ 'tenant',
224
+ 'tnCAndPPAcceptanceDate',
225
+ 'tnCAndPPAccepted',
226
+ 'userID',
227
+ 'userName',
228
+ 'verificationCode',
229
+ ]
230
+ payload_required_keys = %w[eMail password tenant userName]
231
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
232
+
233
+ exec_http_request('post', '/api/v2/User/{strToken}', **args)
129
234
  end
130
235
 
131
- # DELETE /api/v2/User/{strToken}/{strUserID}
132
- # Deletes a User object.
236
+ # GET /api/v2/User/{strToken}/{strUserID}
237
+ # Gets the details of a User object.
133
238
  # Params list:
134
239
  # @param [string] strToken The login token. required
135
240
  # @param [string] strUserID The User object ID. required
136
- # delete_user(strToken:, strUserID:)
137
- def self.delete_user(**args)
138
- exec_http_request('delete', '/api/v2/User/{strToken}/{strUserID}', args)
139
- end
241
+ # get_user_by_id(strToken:, strUserID:)
242
+ def self.get_user_by_id(strToken:, strUserID:)
243
+ args = build_arguments(binding)
140
244
 
141
- # GET /api/v2/Users/{strToken}
142
- # Gets a list of all the existing User objects.
143
- # Params list:
144
- # @param [string] strToken The login token. required
145
- # users(strToken:)
146
- def self.users(**args)
147
- exec_http_request('get', '/api/v2/Users/{strToken}', args)
245
+ exec_http_request('get', '/api/v2/User/{strToken}/{strUserID}', **args)
148
246
  end
149
247
 
150
- # POST /api/v2/User
151
- # Registers a new user.
248
+ # PATCH /api/v2/User/{strToken}/{strUserID}
249
+ # Updates the details of a User object (including its password).
152
250
  # Params list:
251
+ # @param [string] strToken The login token. required
252
+ # @param [string] strUserID The User object ID. required
153
253
  # @param [object] payload request payload. optional
154
- # @param [string] payload.tenant . optional
254
+ # @param [string] payload.tenant . required
155
255
  # @param [string] payload.userID . optional
156
- # @param [string] payload.userName . optional
157
- # @param [string] payload.password . optional
256
+ # @param [string] payload.userName . required
257
+ # @param [string] payload.password . required
158
258
  # @param [string] payload.newPassword . optional
159
- # @param [string] payload.eMail . optional
259
+ # @param [string] payload.eMail . required
260
+ # @param [string] payload.avatarURL . optional
261
+ # @param [string] payload.avatar3DURL . optional
262
+ # @param [string] payload.avatar3DURLType . optional
160
263
  # @param [boolean] payload.dontSendInvitationEmail . optional
161
264
  # @param [string] payload.referral . optional
162
265
  # @param [string] payload.couponCode . optional
@@ -182,7 +285,9 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
182
285
  # @param [boolean] payload.canEditIntegrations . optional
183
286
  # @param [boolean] payload.canEditDynamicIntents . optional
184
287
  # @param [boolean] payload.canEditMemoriChaining . optional
288
+ # @param [boolean] payload.canEditDCMIntegration . optional
185
289
  # @param [boolean] payload.canRunSnippets . optional
290
+ # @param [boolean] payload.enableBadges . optional
186
291
  # @param [string] payload.birthDate . optional
187
292
  # @param [integer] payload.age . optional
188
293
  # @param [boolean] payload.tnCAndPPAccepted . optional
@@ -191,21 +296,98 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
191
296
  # @param [string] payload.flowID . optional
192
297
  # @param [string] payload.creationTimestamp . optional
193
298
  # @param [string] payload.lastChangeTimestamp . optional
194
- # register_user()
195
- def self.register_user(**args)
196
- exec_http_request('post', '/api/v2/User', args)
299
+ # update_user(strToken:, strUserID:, payload: {})
300
+ def self.update_user(strToken:, strUserID:, payload: {})
301
+ args = build_arguments(binding)
302
+ payload_keys = [
303
+ 'admin',
304
+ 'age',
305
+ 'avatar3DURL',
306
+ 'avatar3DURLType',
307
+ 'avatarURL',
308
+ 'birthDate',
309
+ 'canAccessAPI',
310
+ 'canCreateMemori',
311
+ 'canEditDCMIntegration',
312
+ 'canEditDynamicIntents',
313
+ 'canEditIntegrations',
314
+ 'canEditMemoriChaining',
315
+ 'canRunSnippets',
316
+ 'couponCode',
317
+ 'creationTimestamp',
318
+ 'defaultCompletionProvider',
319
+ 'defaultCompletionProviderConfig',
320
+ 'dontSendInvitationEmail',
321
+ 'eMail',
322
+ 'enableBadges',
323
+ 'flowID',
324
+ 'lastChangeTimestamp',
325
+ 'maxCompletions',
326
+ 'maxFreeSessions',
327
+ 'maxImportSize',
328
+ 'maxMemori',
329
+ 'monthCompletions',
330
+ 'monthImportedSize',
331
+ 'monthSessions',
332
+ 'monthValidSessions',
333
+ 'newPassword',
334
+ 'newsletterSubscribed',
335
+ 'nonFreeSessionCost',
336
+ 'notificationPrefs',
337
+ 'numMemori',
338
+ 'password',
339
+ 'paying',
340
+ 'referral',
341
+ 'superAdmin',
342
+ 'tenant',
343
+ 'tnCAndPPAcceptanceDate',
344
+ 'tnCAndPPAccepted',
345
+ 'userID',
346
+ 'userName',
347
+ 'verificationCode',
348
+ ]
349
+ payload_required_keys = %w[eMail password tenant userName]
350
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
351
+
352
+ exec_http_request('patch', '/api/v2/User/{strToken}/{strUserID}', **args)
197
353
  end
198
354
 
199
- # POST /api/v2/ResendVerificationCode
200
- # Re-sends the verification code to confirm a pending User registration.
355
+ # DELETE /api/v2/User/{strToken}/{strUserID}
356
+ # Deletes a User object.
357
+ # Params list:
358
+ # @param [string] strToken The login token. required
359
+ # @param [string] strUserID The User object ID. required
360
+ # delete_user(strToken:, strUserID:)
361
+ def self.delete_user(strToken:, strUserID:)
362
+ args = build_arguments(binding)
363
+
364
+ exec_http_request('delete', '/api/v2/User/{strToken}/{strUserID}', **args)
365
+ end
366
+
367
+ # GET /api/v2/Users/{strToken}
368
+ # Gets a list of all the existing User objects.
369
+ # Params list:
370
+ # @param [string] strToken The login token. required
371
+ # list_users(strToken:)
372
+ def self.list_users(strToken:)
373
+ args = build_arguments(binding)
374
+
375
+ exec_http_request('get', '/api/v2/Users/{strToken}', **args)
376
+ end
377
+
378
+ # POST /api/v2/User
379
+ # Registers a new user.
201
380
  # Params list:
202
381
  # @param [object] payload request payload. optional
203
- # @param [string] payload.tenant . optional
382
+ # @param [string] payload.tenant . required
204
383
  # @param [string] payload.userID . optional
205
- # @param [string] payload.userName . optional
206
- # @param [string] payload.password . optional
384
+ # @param [string] payload.userName . required
385
+ # @param [string] payload.password . required
207
386
  # @param [string] payload.newPassword . optional
208
- # @param [string] payload.eMail . optional
387
+ # @param [string] payload.eMail . required
388
+ # @param [string] payload.avatarURL . optional
389
+ # @param [string] payload.avatar3DURL . optional
390
+ # @param [string] payload.avatar3DURLType . optional
209
391
  # @param [boolean] payload.dontSendInvitationEmail . optional
210
392
  # @param [string] payload.referral . optional
211
393
  # @param [string] payload.couponCode . optional
@@ -231,7 +413,9 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
231
413
  # @param [boolean] payload.canEditIntegrations . optional
232
414
  # @param [boolean] payload.canEditDynamicIntents . optional
233
415
  # @param [boolean] payload.canEditMemoriChaining . optional
416
+ # @param [boolean] payload.canEditDCMIntegration . optional
234
417
  # @param [boolean] payload.canRunSnippets . optional
418
+ # @param [boolean] payload.enableBadges . optional
235
419
  # @param [string] payload.birthDate . optional
236
420
  # @param [integer] payload.age . optional
237
421
  # @param [boolean] payload.tnCAndPPAccepted . optional
@@ -240,21 +424,75 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
240
424
  # @param [string] payload.flowID . optional
241
425
  # @param [string] payload.creationTimestamp . optional
242
426
  # @param [string] payload.lastChangeTimestamp . optional
243
- # resend_verification_code()
244
- def self.resend_verification_code(**args)
245
- exec_http_request('post', '/api/v2/ResendVerificationCode', args)
427
+ # register_user(payload: {})
428
+ def self.register_user(payload: {})
429
+ args = build_arguments(binding)
430
+ payload_keys = [
431
+ 'admin',
432
+ 'age',
433
+ 'avatar3DURL',
434
+ 'avatar3DURLType',
435
+ 'avatarURL',
436
+ 'birthDate',
437
+ 'canAccessAPI',
438
+ 'canCreateMemori',
439
+ 'canEditDCMIntegration',
440
+ 'canEditDynamicIntents',
441
+ 'canEditIntegrations',
442
+ 'canEditMemoriChaining',
443
+ 'canRunSnippets',
444
+ 'couponCode',
445
+ 'creationTimestamp',
446
+ 'defaultCompletionProvider',
447
+ 'defaultCompletionProviderConfig',
448
+ 'dontSendInvitationEmail',
449
+ 'eMail',
450
+ 'enableBadges',
451
+ 'flowID',
452
+ 'lastChangeTimestamp',
453
+ 'maxCompletions',
454
+ 'maxFreeSessions',
455
+ 'maxImportSize',
456
+ 'maxMemori',
457
+ 'monthCompletions',
458
+ 'monthImportedSize',
459
+ 'monthSessions',
460
+ 'monthValidSessions',
461
+ 'newPassword',
462
+ 'newsletterSubscribed',
463
+ 'nonFreeSessionCost',
464
+ 'notificationPrefs',
465
+ 'numMemori',
466
+ 'password',
467
+ 'paying',
468
+ 'referral',
469
+ 'superAdmin',
470
+ 'tenant',
471
+ 'tnCAndPPAcceptanceDate',
472
+ 'tnCAndPPAccepted',
473
+ 'userID',
474
+ 'userName',
475
+ 'verificationCode',
476
+ ]
477
+ payload_required_keys = %w[eMail password tenant userName]
478
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
479
+
480
+ exec_http_request('post', '/api/v2/User', **args)
246
481
  end
247
482
 
248
- # POST /api/v2/UserConfirm
249
- # Confirms the registration of a User and performs a Login.
483
+ # POST /api/v2/ResendVerificationCode
484
+ # Re-sends the verification code to confirm a pending User registration.
250
485
  # Params list:
251
486
  # @param [object] payload request payload. optional
252
- # @param [string] payload.tenant . optional
487
+ # @param [string] payload.tenant . required
253
488
  # @param [string] payload.userID . optional
254
- # @param [string] payload.userName . optional
255
- # @param [string] payload.password . optional
489
+ # @param [string] payload.userName . required
490
+ # @param [string] payload.password . required
256
491
  # @param [string] payload.newPassword . optional
257
- # @param [string] payload.eMail . optional
492
+ # @param [string] payload.eMail . required
493
+ # @param [string] payload.avatarURL . optional
494
+ # @param [string] payload.avatar3DURL . optional
495
+ # @param [string] payload.avatar3DURLType . optional
258
496
  # @param [boolean] payload.dontSendInvitationEmail . optional
259
497
  # @param [string] payload.referral . optional
260
498
  # @param [string] payload.couponCode . optional
@@ -280,7 +518,9 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
280
518
  # @param [boolean] payload.canEditIntegrations . optional
281
519
  # @param [boolean] payload.canEditDynamicIntents . optional
282
520
  # @param [boolean] payload.canEditMemoriChaining . optional
521
+ # @param [boolean] payload.canEditDCMIntegration . optional
283
522
  # @param [boolean] payload.canRunSnippets . optional
523
+ # @param [boolean] payload.enableBadges . optional
284
524
  # @param [string] payload.birthDate . optional
285
525
  # @param [integer] payload.age . optional
286
526
  # @param [boolean] payload.tnCAndPPAccepted . optional
@@ -289,22 +529,75 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
289
529
  # @param [string] payload.flowID . optional
290
530
  # @param [string] payload.creationTimestamp . optional
291
531
  # @param [string] payload.lastChangeTimestamp . optional
292
- # user_confirm()
293
- def self.user_confirm(**args)
294
- exec_http_request('post', '/api/v2/UserConfirm', args)
532
+ # resend_verification_code(payload: {})
533
+ def self.resend_verification_code(payload: {})
534
+ args = build_arguments(binding)
535
+ payload_keys = [
536
+ 'admin',
537
+ 'age',
538
+ 'avatar3DURL',
539
+ 'avatar3DURLType',
540
+ 'avatarURL',
541
+ 'birthDate',
542
+ 'canAccessAPI',
543
+ 'canCreateMemori',
544
+ 'canEditDCMIntegration',
545
+ 'canEditDynamicIntents',
546
+ 'canEditIntegrations',
547
+ 'canEditMemoriChaining',
548
+ 'canRunSnippets',
549
+ 'couponCode',
550
+ 'creationTimestamp',
551
+ 'defaultCompletionProvider',
552
+ 'defaultCompletionProviderConfig',
553
+ 'dontSendInvitationEmail',
554
+ 'eMail',
555
+ 'enableBadges',
556
+ 'flowID',
557
+ 'lastChangeTimestamp',
558
+ 'maxCompletions',
559
+ 'maxFreeSessions',
560
+ 'maxImportSize',
561
+ 'maxMemori',
562
+ 'monthCompletions',
563
+ 'monthImportedSize',
564
+ 'monthSessions',
565
+ 'monthValidSessions',
566
+ 'newPassword',
567
+ 'newsletterSubscribed',
568
+ 'nonFreeSessionCost',
569
+ 'notificationPrefs',
570
+ 'numMemori',
571
+ 'password',
572
+ 'paying',
573
+ 'referral',
574
+ 'superAdmin',
575
+ 'tenant',
576
+ 'tnCAndPPAcceptanceDate',
577
+ 'tnCAndPPAccepted',
578
+ 'userID',
579
+ 'userName',
580
+ 'verificationCode',
581
+ ]
582
+ payload_required_keys = %w[eMail password tenant userName]
583
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
584
+
585
+ exec_http_request('post', '/api/v2/ResendVerificationCode', **args)
295
586
  end
296
587
 
297
- # POST /api/v2/User/{strToken}
298
- # Creates a new user.
588
+ # POST /api/v2/UserConfirm
589
+ # Confirms the registration of a User and performs a Login.
299
590
  # Params list:
300
- # @param [string] strToken The login token. required
301
591
  # @param [object] payload request payload. optional
302
- # @param [string] payload.tenant . optional
592
+ # @param [string] payload.tenant . required
303
593
  # @param [string] payload.userID . optional
304
- # @param [string] payload.userName . optional
305
- # @param [string] payload.password . optional
594
+ # @param [string] payload.userName . required
595
+ # @param [string] payload.password . required
306
596
  # @param [string] payload.newPassword . optional
307
- # @param [string] payload.eMail . optional
597
+ # @param [string] payload.eMail . required
598
+ # @param [string] payload.avatarURL . optional
599
+ # @param [string] payload.avatar3DURL . optional
600
+ # @param [string] payload.avatar3DURLType . optional
308
601
  # @param [boolean] payload.dontSendInvitationEmail . optional
309
602
  # @param [string] payload.referral . optional
310
603
  # @param [string] payload.couponCode . optional
@@ -330,7 +623,9 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
330
623
  # @param [boolean] payload.canEditIntegrations . optional
331
624
  # @param [boolean] payload.canEditDynamicIntents . optional
332
625
  # @param [boolean] payload.canEditMemoriChaining . optional
626
+ # @param [boolean] payload.canEditDCMIntegration . optional
333
627
  # @param [boolean] payload.canRunSnippets . optional
628
+ # @param [boolean] payload.enableBadges . optional
334
629
  # @param [string] payload.birthDate . optional
335
630
  # @param [integer] payload.age . optional
336
631
  # @param [boolean] payload.tnCAndPPAccepted . optional
@@ -339,21 +634,75 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
339
634
  # @param [string] payload.flowID . optional
340
635
  # @param [string] payload.creationTimestamp . optional
341
636
  # @param [string] payload.lastChangeTimestamp . optional
342
- # create_user(strToken:)
343
- def self.create_user(**args)
344
- exec_http_request('post', '/api/v2/User/{strToken}', args)
637
+ # confirm_registration(payload: {})
638
+ def self.confirm_registration(payload: {})
639
+ args = build_arguments(binding)
640
+ payload_keys = [
641
+ 'admin',
642
+ 'age',
643
+ 'avatar3DURL',
644
+ 'avatar3DURLType',
645
+ 'avatarURL',
646
+ 'birthDate',
647
+ 'canAccessAPI',
648
+ 'canCreateMemori',
649
+ 'canEditDCMIntegration',
650
+ 'canEditDynamicIntents',
651
+ 'canEditIntegrations',
652
+ 'canEditMemoriChaining',
653
+ 'canRunSnippets',
654
+ 'couponCode',
655
+ 'creationTimestamp',
656
+ 'defaultCompletionProvider',
657
+ 'defaultCompletionProviderConfig',
658
+ 'dontSendInvitationEmail',
659
+ 'eMail',
660
+ 'enableBadges',
661
+ 'flowID',
662
+ 'lastChangeTimestamp',
663
+ 'maxCompletions',
664
+ 'maxFreeSessions',
665
+ 'maxImportSize',
666
+ 'maxMemori',
667
+ 'monthCompletions',
668
+ 'monthImportedSize',
669
+ 'monthSessions',
670
+ 'monthValidSessions',
671
+ 'newPassword',
672
+ 'newsletterSubscribed',
673
+ 'nonFreeSessionCost',
674
+ 'notificationPrefs',
675
+ 'numMemori',
676
+ 'password',
677
+ 'paying',
678
+ 'referral',
679
+ 'superAdmin',
680
+ 'tenant',
681
+ 'tnCAndPPAcceptanceDate',
682
+ 'tnCAndPPAccepted',
683
+ 'userID',
684
+ 'userName',
685
+ 'verificationCode',
686
+ ]
687
+ payload_required_keys = %w[eMail password tenant userName]
688
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
689
+
690
+ exec_http_request('post', '/api/v2/UserConfirm', **args)
345
691
  end
346
692
 
347
693
  # POST /api/v2/ResetPassword
348
694
  # Resets a User's password.
349
695
  # Params list:
350
696
  # @param [object] payload request payload. optional
351
- # @param [string] payload.tenant . optional
697
+ # @param [string] payload.tenant . required
352
698
  # @param [string] payload.userID . optional
353
- # @param [string] payload.userName . optional
354
- # @param [string] payload.password . optional
699
+ # @param [string] payload.userName . required
700
+ # @param [string] payload.password . required
355
701
  # @param [string] payload.newPassword . optional
356
- # @param [string] payload.eMail . optional
702
+ # @param [string] payload.eMail . required
703
+ # @param [string] payload.avatarURL . optional
704
+ # @param [string] payload.avatar3DURL . optional
705
+ # @param [string] payload.avatar3DURLType . optional
357
706
  # @param [boolean] payload.dontSendInvitationEmail . optional
358
707
  # @param [string] payload.referral . optional
359
708
  # @param [string] payload.couponCode . optional
@@ -379,7 +728,9 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
379
728
  # @param [boolean] payload.canEditIntegrations . optional
380
729
  # @param [boolean] payload.canEditDynamicIntents . optional
381
730
  # @param [boolean] payload.canEditMemoriChaining . optional
731
+ # @param [boolean] payload.canEditDCMIntegration . optional
382
732
  # @param [boolean] payload.canRunSnippets . optional
733
+ # @param [boolean] payload.enableBadges . optional
383
734
  # @param [string] payload.birthDate . optional
384
735
  # @param [integer] payload.age . optional
385
736
  # @param [boolean] payload.tnCAndPPAccepted . optional
@@ -388,21 +739,75 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
388
739
  # @param [string] payload.flowID . optional
389
740
  # @param [string] payload.creationTimestamp . optional
390
741
  # @param [string] payload.lastChangeTimestamp . optional
391
- # reset_password()
392
- def self.reset_password(**args)
393
- exec_http_request('post', '/api/v2/ResetPassword', args)
742
+ # reset_user_password(payload: {})
743
+ def self.reset_user_password(payload: {})
744
+ args = build_arguments(binding)
745
+ payload_keys = [
746
+ 'admin',
747
+ 'age',
748
+ 'avatar3DURL',
749
+ 'avatar3DURLType',
750
+ 'avatarURL',
751
+ 'birthDate',
752
+ 'canAccessAPI',
753
+ 'canCreateMemori',
754
+ 'canEditDCMIntegration',
755
+ 'canEditDynamicIntents',
756
+ 'canEditIntegrations',
757
+ 'canEditMemoriChaining',
758
+ 'canRunSnippets',
759
+ 'couponCode',
760
+ 'creationTimestamp',
761
+ 'defaultCompletionProvider',
762
+ 'defaultCompletionProviderConfig',
763
+ 'dontSendInvitationEmail',
764
+ 'eMail',
765
+ 'enableBadges',
766
+ 'flowID',
767
+ 'lastChangeTimestamp',
768
+ 'maxCompletions',
769
+ 'maxFreeSessions',
770
+ 'maxImportSize',
771
+ 'maxMemori',
772
+ 'monthCompletions',
773
+ 'monthImportedSize',
774
+ 'monthSessions',
775
+ 'monthValidSessions',
776
+ 'newPassword',
777
+ 'newsletterSubscribed',
778
+ 'nonFreeSessionCost',
779
+ 'notificationPrefs',
780
+ 'numMemori',
781
+ 'password',
782
+ 'paying',
783
+ 'referral',
784
+ 'superAdmin',
785
+ 'tenant',
786
+ 'tnCAndPPAcceptanceDate',
787
+ 'tnCAndPPAccepted',
788
+ 'userID',
789
+ 'userName',
790
+ 'verificationCode',
791
+ ]
792
+ payload_required_keys = %w[eMail password tenant userName]
793
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
794
+
795
+ exec_http_request('post', '/api/v2/ResetPassword', **args)
394
796
  end
395
797
 
396
798
  # POST /api/v2/ResetConfirm
397
799
  # Confirms the password reset of a User and performs a Login.
398
800
  # Params list:
399
801
  # @param [object] payload request payload. optional
400
- # @param [string] payload.tenant . optional
802
+ # @param [string] payload.tenant . required
401
803
  # @param [string] payload.userID . optional
402
- # @param [string] payload.userName . optional
403
- # @param [string] payload.password . optional
804
+ # @param [string] payload.userName . required
805
+ # @param [string] payload.password . required
404
806
  # @param [string] payload.newPassword . optional
405
- # @param [string] payload.eMail . optional
807
+ # @param [string] payload.eMail . required
808
+ # @param [string] payload.avatarURL . optional
809
+ # @param [string] payload.avatar3DURL . optional
810
+ # @param [string] payload.avatar3DURLType . optional
406
811
  # @param [boolean] payload.dontSendInvitationEmail . optional
407
812
  # @param [string] payload.referral . optional
408
813
  # @param [string] payload.couponCode . optional
@@ -428,7 +833,9 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
428
833
  # @param [boolean] payload.canEditIntegrations . optional
429
834
  # @param [boolean] payload.canEditDynamicIntents . optional
430
835
  # @param [boolean] payload.canEditMemoriChaining . optional
836
+ # @param [boolean] payload.canEditDCMIntegration . optional
431
837
  # @param [boolean] payload.canRunSnippets . optional
838
+ # @param [boolean] payload.enableBadges . optional
432
839
  # @param [string] payload.birthDate . optional
433
840
  # @param [integer] payload.age . optional
434
841
  # @param [boolean] payload.tnCAndPPAccepted . optional
@@ -437,21 +844,75 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
437
844
  # @param [string] payload.flowID . optional
438
845
  # @param [string] payload.creationTimestamp . optional
439
846
  # @param [string] payload.lastChangeTimestamp . optional
440
- # reset_confirm()
441
- def self.reset_confirm(**args)
442
- exec_http_request('post', '/api/v2/ResetConfirm', args)
847
+ # confirm_password_reset(payload: {})
848
+ def self.confirm_password_reset(payload: {})
849
+ args = build_arguments(binding)
850
+ payload_keys = [
851
+ 'admin',
852
+ 'age',
853
+ 'avatar3DURL',
854
+ 'avatar3DURLType',
855
+ 'avatarURL',
856
+ 'birthDate',
857
+ 'canAccessAPI',
858
+ 'canCreateMemori',
859
+ 'canEditDCMIntegration',
860
+ 'canEditDynamicIntents',
861
+ 'canEditIntegrations',
862
+ 'canEditMemoriChaining',
863
+ 'canRunSnippets',
864
+ 'couponCode',
865
+ 'creationTimestamp',
866
+ 'defaultCompletionProvider',
867
+ 'defaultCompletionProviderConfig',
868
+ 'dontSendInvitationEmail',
869
+ 'eMail',
870
+ 'enableBadges',
871
+ 'flowID',
872
+ 'lastChangeTimestamp',
873
+ 'maxCompletions',
874
+ 'maxFreeSessions',
875
+ 'maxImportSize',
876
+ 'maxMemori',
877
+ 'monthCompletions',
878
+ 'monthImportedSize',
879
+ 'monthSessions',
880
+ 'monthValidSessions',
881
+ 'newPassword',
882
+ 'newsletterSubscribed',
883
+ 'nonFreeSessionCost',
884
+ 'notificationPrefs',
885
+ 'numMemori',
886
+ 'password',
887
+ 'paying',
888
+ 'referral',
889
+ 'superAdmin',
890
+ 'tenant',
891
+ 'tnCAndPPAcceptanceDate',
892
+ 'tnCAndPPAccepted',
893
+ 'userID',
894
+ 'userName',
895
+ 'verificationCode',
896
+ ]
897
+ payload_required_keys = %w[eMail password tenant userName]
898
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
899
+
900
+ exec_http_request('post', '/api/v2/ResetConfirm', **args)
443
901
  end
444
902
 
445
903
  # POST /api/v2/RecoverUserName
446
904
  # Recovers a User's name and sends it to their configured e-mail.
447
905
  # Params list:
448
906
  # @param [object] payload request payload. optional
449
- # @param [string] payload.tenant . optional
907
+ # @param [string] payload.tenant . required
450
908
  # @param [string] payload.userID . optional
451
- # @param [string] payload.userName . optional
452
- # @param [string] payload.password . optional
909
+ # @param [string] payload.userName . required
910
+ # @param [string] payload.password . required
453
911
  # @param [string] payload.newPassword . optional
454
- # @param [string] payload.eMail . optional
912
+ # @param [string] payload.eMail . required
913
+ # @param [string] payload.avatarURL . optional
914
+ # @param [string] payload.avatar3DURL . optional
915
+ # @param [string] payload.avatar3DURLType . optional
455
916
  # @param [boolean] payload.dontSendInvitationEmail . optional
456
917
  # @param [string] payload.referral . optional
457
918
  # @param [string] payload.couponCode . optional
@@ -477,7 +938,9 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
477
938
  # @param [boolean] payload.canEditIntegrations . optional
478
939
  # @param [boolean] payload.canEditDynamicIntents . optional
479
940
  # @param [boolean] payload.canEditMemoriChaining . optional
941
+ # @param [boolean] payload.canEditDCMIntegration . optional
480
942
  # @param [boolean] payload.canRunSnippets . optional
943
+ # @param [boolean] payload.enableBadges . optional
481
944
  # @param [string] payload.birthDate . optional
482
945
  # @param [integer] payload.age . optional
483
946
  # @param [boolean] payload.tnCAndPPAccepted . optional
@@ -486,9 +949,60 @@ class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
486
949
  # @param [string] payload.flowID . optional
487
950
  # @param [string] payload.creationTimestamp . optional
488
951
  # @param [string] payload.lastChangeTimestamp . optional
489
- # recover_user_name()
490
- def self.recover_user_name(**args)
491
- exec_http_request('post', '/api/v2/RecoverUserName', args)
952
+ # recover_user_name(payload: {})
953
+ def self.recover_user_name(payload: {})
954
+ args = build_arguments(binding)
955
+ payload_keys = [
956
+ 'admin',
957
+ 'age',
958
+ 'avatar3DURL',
959
+ 'avatar3DURLType',
960
+ 'avatarURL',
961
+ 'birthDate',
962
+ 'canAccessAPI',
963
+ 'canCreateMemori',
964
+ 'canEditDCMIntegration',
965
+ 'canEditDynamicIntents',
966
+ 'canEditIntegrations',
967
+ 'canEditMemoriChaining',
968
+ 'canRunSnippets',
969
+ 'couponCode',
970
+ 'creationTimestamp',
971
+ 'defaultCompletionProvider',
972
+ 'defaultCompletionProviderConfig',
973
+ 'dontSendInvitationEmail',
974
+ 'eMail',
975
+ 'enableBadges',
976
+ 'flowID',
977
+ 'lastChangeTimestamp',
978
+ 'maxCompletions',
979
+ 'maxFreeSessions',
980
+ 'maxImportSize',
981
+ 'maxMemori',
982
+ 'monthCompletions',
983
+ 'monthImportedSize',
984
+ 'monthSessions',
985
+ 'monthValidSessions',
986
+ 'newPassword',
987
+ 'newsletterSubscribed',
988
+ 'nonFreeSessionCost',
989
+ 'notificationPrefs',
990
+ 'numMemori',
991
+ 'password',
992
+ 'paying',
993
+ 'referral',
994
+ 'superAdmin',
995
+ 'tenant',
996
+ 'tnCAndPPAcceptanceDate',
997
+ 'tnCAndPPAccepted',
998
+ 'userID',
999
+ 'userName',
1000
+ 'verificationCode',
1001
+ ]
1002
+ payload_required_keys = %w[eMail password tenant userName]
1003
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
1004
+
1005
+ exec_http_request('post', '/api/v2/RecoverUserName', **args)
492
1006
  end
493
1007
 
494
1008