memori-client 0.1.9 → 0.2.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 (102) hide show
  1. checksums.yaml +4 -4
  2. data/backend_overrides.jsonc +4 -0
  3. data/engine_overrides.jsonc +3 -0
  4. data/lib/memori_client/client.rb +49 -0
  5. data/lib/memori_client/client_factory.rb +105 -0
  6. data/lib/memori_client/engine/hmac_helper.rb +1 -1
  7. data/lib/memori_client/http_client.rb +4 -17
  8. data/lib/memori_client/operation.rb +132 -0
  9. data/lib/memori_client/proxy/client.rb +115 -0
  10. data/lib/memori_client/resource.rb +174 -26
  11. data/lib/memori_client/resource_proxy.rb +25 -0
  12. data/lib/memori_client/response.rb +48 -0
  13. data/lib/memori_client/swagger/get_module_and_method.rb +44 -0
  14. data/lib/memori_client/swagger/process_specification.rb +127 -0
  15. data/lib/memori_client/swagger/schema_store.rb +26 -0
  16. data/lib/memori_client.rb +14 -42
  17. data/lib/tasks/memori_client.rake +0 -7
  18. metadata +17 -90
  19. data/doc/MemoriClient::Backend::V1::Asset.md +0 -117
  20. data/doc/MemoriClient::Backend::V2::ActionLog.md +0 -37
  21. data/doc/MemoriClient::Backend::V2::Analysis.md +0 -39
  22. data/doc/MemoriClient::Backend::V2::Asset.md +0 -102
  23. data/doc/MemoriClient::Backend::V2::Badge.md +0 -64
  24. data/doc/MemoriClient::Backend::V2::CompletionConfig.md +0 -115
  25. data/doc/MemoriClient::Backend::V2::ConsumptionLog.md +0 -57
  26. data/doc/MemoriClient::Backend::V2::ImportExport.md +0 -180
  27. data/doc/MemoriClient::Backend::V2::Integration.md +0 -117
  28. data/doc/MemoriClient::Backend::V2::Invitation.md +0 -179
  29. data/doc/MemoriClient::Backend::V2::Memori.md +0 -394
  30. data/doc/MemoriClient::Backend::V2::MemoriList.md +0 -147
  31. data/doc/MemoriClient::Backend::V2::Notification.md +0 -31
  32. data/doc/MemoriClient::Backend::V2::Process.md +0 -64
  33. data/doc/MemoriClient::Backend::V2::Tenant.md +0 -142
  34. data/doc/MemoriClient::Backend::V2::User.md +0 -647
  35. data/doc/MemoriClient::Engine::V2::ChatLog.md +0 -82
  36. data/doc/MemoriClient::Engine::V2::ContextVar.md +0 -46
  37. data/doc/MemoriClient::Engine::V2::CorrelationPair.md +0 -72
  38. data/doc/MemoriClient::Engine::V2::CustomDictionary.md +0 -108
  39. data/doc/MemoriClient::Engine::V2::Dialog.md +0 -152
  40. data/doc/MemoriClient::Engine::V2::EventLog.md +0 -85
  41. data/doc/MemoriClient::Engine::V2::ExpertReference.md +0 -116
  42. data/doc/MemoriClient::Engine::V2::Function.md +0 -140
  43. data/doc/MemoriClient::Engine::V2::Intent.md +0 -225
  44. data/doc/MemoriClient::Engine::V2::LocalizationKey.md +0 -105
  45. data/doc/MemoriClient::Engine::V2::Medium.md +0 -118
  46. data/doc/MemoriClient::Engine::V2::Memory.md +0 -244
  47. data/doc/MemoriClient::Engine::V2::NLP.md +0 -100
  48. data/doc/MemoriClient::Engine::V2::Person.md +0 -114
  49. data/doc/MemoriClient::Engine::V2::Search.md +0 -151
  50. data/doc/MemoriClient::Engine::V2::Session.md +0 -55
  51. data/doc/MemoriClient::Engine::V2::Stat.md +0 -18
  52. data/doc/MemoriClient::Engine::V2::Topic.md +0 -80
  53. data/doc/MemoriClient::Engine::V2::UnansweredQuestion.md +0 -75
  54. data/doc/MemoriClient::Engine::V2::User.md +0 -140
  55. data/doc/MemoriClient::Engine::V2::WebHook.md +0 -67
  56. data/lib/memori_client/backend/resource.rb +0 -39
  57. data/lib/memori_client/backend/resources.rb +0 -16
  58. data/lib/memori_client/backend/v1/asset.rb +0 -120
  59. data/lib/memori_client/backend/v2/action_log.rb +0 -44
  60. data/lib/memori_client/backend/v2/analysis.rb +0 -54
  61. data/lib/memori_client/backend/v2/asset.rb +0 -130
  62. data/lib/memori_client/backend/v2/badge.rb +0 -77
  63. data/lib/memori_client/backend/v2/completion_config.rb +0 -202
  64. data/lib/memori_client/backend/v2/consumption_log.rb +0 -70
  65. data/lib/memori_client/backend/v2/import_export.rb +0 -327
  66. data/lib/memori_client/backend/v2/integration.rb +0 -180
  67. data/lib/memori_client/backend/v2/invitation.rb +0 -252
  68. data/lib/memori_client/backend/v2/memori.rb +0 -954
  69. data/lib/memori_client/backend/v2/memori_list.rb +0 -152
  70. data/lib/memori_client/backend/v2/notification.rb +0 -32
  71. data/lib/memori_client/backend/v2/process.rb +0 -70
  72. data/lib/memori_client/backend/v2/tenant.rb +0 -293
  73. data/lib/memori_client/backend/v2/user.rb +0 -1520
  74. data/lib/memori_client/configuration.rb +0 -20
  75. data/lib/memori_client/engine/resource.rb +0 -13
  76. data/lib/memori_client/engine/resources.rb +0 -21
  77. data/lib/memori_client/engine/v2/chat_log.rb +0 -92
  78. data/lib/memori_client/engine/v2/completion_log.rb +0 -17
  79. data/lib/memori_client/engine/v2/context_var.rb +0 -48
  80. data/lib/memori_client/engine/v2/correlation_pair.rb +0 -99
  81. data/lib/memori_client/engine/v2/custom_dictionary.rb +0 -152
  82. data/lib/memori_client/engine/v2/dialog.rb +0 -223
  83. data/lib/memori_client/engine/v2/event_log.rb +0 -98
  84. data/lib/memori_client/engine/v2/expert_reference.rb +0 -176
  85. data/lib/memori_client/engine/v2/function.rb +0 -220
  86. data/lib/memori_client/engine/v2/intent.rb +0 -336
  87. data/lib/memori_client/engine/v2/localization_key.rb +0 -144
  88. data/lib/memori_client/engine/v2/medium.rb +0 -178
  89. data/lib/memori_client/engine/v2/memori.rb +0 -329
  90. data/lib/memori_client/engine/v2/memory.rb +0 -477
  91. data/lib/memori_client/engine/v2/nlp.rb +0 -137
  92. data/lib/memori_client/engine/v2/person.rb +0 -170
  93. data/lib/memori_client/engine/v2/private/memori.rb +0 -17
  94. data/lib/memori_client/engine/v2/private/memori_block.rb +0 -24
  95. data/lib/memori_client/engine/v2/prompted_question.rb +0 -121
  96. data/lib/memori_client/engine/v2/search.rb +0 -318
  97. data/lib/memori_client/engine/v2/session.rb +0 -80
  98. data/lib/memori_client/engine/v2/stat.rb +0 -20
  99. data/lib/memori_client/engine/v2/topic.rb +0 -88
  100. data/lib/memori_client/engine/v2/unanswered_question.rb +0 -108
  101. data/lib/memori_client/engine/v2/user.rb +0 -152
  102. data/lib/memori_client/engine/v2/web_hook.rb +0 -128
data/lib/memori_client/backend/v2/user.rb DELETED
@@ -1,1520 +0,0 @@
1
- # Generated on 2025-01-27 20:29:51 +0000
2
- class MemoriClient::Backend::V2::User < MemoriClient::Backend::Resource
3
- # `POST /api/v2/Login`
4
- #
5
- # Tries a login with the specified credentials and returns a login token if successful.
6
- #
7
- #
8
- # @param [Hash] payload request payload. optional
9
- #
10
- # @param [String] payload.tenant . optional
11
- #
12
- # @param [String] payload.userID . optional
13
- #
14
- # @param [String] payload.userName . optional
15
- #
16
- # @param [String] payload.password . optional
17
- #
18
- # @param [String] payload.newPassword . optional
19
- #
20
- # @param [String] payload.eMail . optional
21
- #
22
- # @param [String] payload.avatarURL . optional
23
- #
24
- # @param [String] payload.avatar3DURL . optional
25
- #
26
- # @param [String] payload.avatar3DURLType . optional
27
- #
28
- # @param [Boolean] payload.dontSendInvitationEmail . optional
29
- #
30
- # @param [String] payload.referral . optional
31
- #
32
- # @param [String] payload.couponCode . optional
33
- #
34
- # @param [Boolean] payload.newsletterSubscribed . optional
35
- #
36
- # @param [Array] payload.notificationPrefs . optional
37
- #
38
- # @param [Boolean] payload.admin . optional
39
- #
40
- # @param [Boolean] payload.superAdmin . optional
41
- #
42
- # @param [Integer] payload.numMemori . optional
43
- #
44
- # @param [Integer] payload.maxMemori . optional
45
- #
46
- # @param [Integer] payload.monthSessions . optional
47
- #
48
- # @param [Integer] payload.monthValidSessions . optional
49
- #
50
- # @param [Integer] payload.monthDeepThoughtValidSessions . optional
51
- #
52
- # @param [Integer] payload.maxFreeSessions . optional
53
- #
54
- # @param [Number] payload.nonFreeSessionCost . optional
55
- #
56
- # @param [Integer] payload.monthCompletions . optional
57
- #
58
- # @param [Integer] payload.monthDeepThoughtCompletions . optional
59
- #
60
- # @param [Integer] payload.monthImportedSize . optional
61
- #
62
- # @param [Integer] payload.maxCompletions . optional
63
- #
64
- # @param [Integer] payload.maxImportSize . optional
65
- #
66
- # @param [Boolean] payload.paying . optional
67
- #
68
- # @param [Boolean] payload.enableMemoriCreation . optional
69
- #
70
- # @param [Boolean] payload.enableBoardOfExperts . optional
71
- #
72
- # @param [Boolean] payload.enableDCMIntegration . optional
73
- #
74
- # @param [Boolean] payload.enableBadges . optional
75
- #
76
- # @param [Boolean] payload.enableDeepThought . optional
77
- #
78
- # @param [Boolean] payload.enableVirtualSpaces . optional
79
- #
80
- # @param [String] payload.birthDate . optional
81
- #
82
- # @param [Integer] payload.age . optional
83
- #
84
- # @param [Boolean] payload.tnCAndPPAccepted . optional
85
- #
86
- # @param [String] payload.tnCAndPPAcceptanceDate . optional
87
- #
88
- # @param [Boolean] payload.pAndCUAccepted . optional
89
- #
90
- # @param [String] payload.pAndCUAcceptanceDate . optional
91
- #
92
- # @param [String] payload.verificationCode . optional
93
- #
94
- # @param [String] payload.flowID . optional
95
- #
96
- # @param [String] payload.creationTimestamp . optional
97
- #
98
- # @param [String] payload.lastChangeTimestamp . optional
99
- #
100
- # `login(payload: {})`
101
- def self.login(payload: {})
102
- args = build_arguments(binding)
103
- payload_keys = [
104
- 'admin',
105
- 'age',
106
- 'avatar3DURL',
107
- 'avatar3DURLType',
108
- 'avatarURL',
109
- 'birthDate',
110
- 'couponCode',
111
- 'creationTimestamp',
112
- 'dontSendInvitationEmail',
113
- 'eMail',
114
- 'enableBadges',
115
- 'enableBoardOfExperts',
116
- 'enableDCMIntegration',
117
- 'enableDeepThought',
118
- 'enableMemoriCreation',
119
- 'enableVirtualSpaces',
120
- 'flowID',
121
- 'lastChangeTimestamp',
122
- 'maxCompletions',
123
- 'maxFreeSessions',
124
- 'maxImportSize',
125
- 'maxMemori',
126
- 'monthCompletions',
127
- 'monthDeepThoughtCompletions',
128
- 'monthDeepThoughtValidSessions',
129
- 'monthImportedSize',
130
- 'monthSessions',
131
- 'monthValidSessions',
132
- 'newPassword',
133
- 'newsletterSubscribed',
134
- 'nonFreeSessionCost',
135
- 'notificationPrefs',
136
- 'numMemori',
137
- 'pAndCUAcceptanceDate',
138
- 'pAndCUAccepted',
139
- 'password',
140
- 'paying',
141
- 'referral',
142
- 'superAdmin',
143
- 'tenant',
144
- 'tnCAndPPAcceptanceDate',
145
- 'tnCAndPPAccepted',
146
- 'userID',
147
- 'userName',
148
- 'verificationCode',
149
- ]
150
- payload_required_keys = %w[]
151
- validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
152
-
153
- exec_http_request('post', '/api/v2/Login', **args)
154
- end
155
-
156
- # `POST /api/v2/Logout/{strToken}`
157
- #
158
- # Logs out the User.
159
- #
160
- #
161
- # @param [string] strToken The login token. required
162
- #
163
- # `logout(strToken:)`
164
- def self.logout(strToken:)
165
- args = build_arguments(binding)
166
-
167
- exec_http_request('post', '/api/v2/Logout/{strToken}', **args)
168
- end
169
-
170
- # `GET /api/v2/User/{strToken}`
171
- #
172
- # Gets the details of the currently logged in User object.
173
- #
174
- #
175
- # @param [string] strToken The login token. required
176
- #
177
- # `get_user(strToken:)`
178
- def self.get_user(strToken:)
179
- args = build_arguments(binding)
180
-
181
- exec_http_request('get', '/api/v2/User/{strToken}', **args)
182
- end
183
-
184
- # `POST /api/v2/User/{strToken}`
185
- #
186
- # Creates a new user.
187
- #
188
- #
189
- # @param [string] strToken The login token. required
190
- #
191
- # @param [Hash] payload request payload. optional
192
- #
193
- # @param [String] payload.tenant . optional
194
- #
195
- # @param [String] payload.userID . optional
196
- #
197
- # @param [String] payload.userName . optional
198
- #
199
- # @param [String] payload.password . optional
200
- #
201
- # @param [String] payload.newPassword . optional
202
- #
203
- # @param [String] payload.eMail . optional
204
- #
205
- # @param [String] payload.avatarURL . optional
206
- #
207
- # @param [String] payload.avatar3DURL . optional
208
- #
209
- # @param [String] payload.avatar3DURLType . optional
210
- #
211
- # @param [Boolean] payload.dontSendInvitationEmail . optional
212
- #
213
- # @param [String] payload.referral . optional
214
- #
215
- # @param [String] payload.couponCode . optional
216
- #
217
- # @param [Boolean] payload.newsletterSubscribed . optional
218
- #
219
- # @param [Array] payload.notificationPrefs . optional
220
- #
221
- # @param [Boolean] payload.admin . optional
222
- #
223
- # @param [Boolean] payload.superAdmin . optional
224
- #
225
- # @param [Integer] payload.numMemori . optional
226
- #
227
- # @param [Integer] payload.maxMemori . optional
228
- #
229
- # @param [Integer] payload.monthSessions . optional
230
- #
231
- # @param [Integer] payload.monthValidSessions . optional
232
- #
233
- # @param [Integer] payload.monthDeepThoughtValidSessions . optional
234
- #
235
- # @param [Integer] payload.maxFreeSessions . optional
236
- #
237
- # @param [Number] payload.nonFreeSessionCost . optional
238
- #
239
- # @param [Integer] payload.monthCompletions . optional
240
- #
241
- # @param [Integer] payload.monthDeepThoughtCompletions . optional
242
- #
243
- # @param [Integer] payload.monthImportedSize . optional
244
- #
245
- # @param [Integer] payload.maxCompletions . optional
246
- #
247
- # @param [Integer] payload.maxImportSize . optional
248
- #
249
- # @param [Boolean] payload.paying . optional
250
- #
251
- # @param [Boolean] payload.enableMemoriCreation . optional
252
- #
253
- # @param [Boolean] payload.enableBoardOfExperts . optional
254
- #
255
- # @param [Boolean] payload.enableDCMIntegration . optional
256
- #
257
- # @param [Boolean] payload.enableBadges . optional
258
- #
259
- # @param [Boolean] payload.enableDeepThought . optional
260
- #
261
- # @param [Boolean] payload.enableVirtualSpaces . optional
262
- #
263
- # @param [String] payload.birthDate . optional
264
- #
265
- # @param [Integer] payload.age . optional
266
- #
267
- # @param [Boolean] payload.tnCAndPPAccepted . optional
268
- #
269
- # @param [String] payload.tnCAndPPAcceptanceDate . optional
270
- #
271
- # @param [Boolean] payload.pAndCUAccepted . optional
272
- #
273
- # @param [String] payload.pAndCUAcceptanceDate . optional
274
- #
275
- # @param [String] payload.verificationCode . optional
276
- #
277
- # @param [String] payload.flowID . optional
278
- #
279
- # @param [String] payload.creationTimestamp . optional
280
- #
281
- # @param [String] payload.lastChangeTimestamp . optional
282
- #
283
- # `create_user(strToken:, payload: {})`
284
- def self.create_user(strToken:, payload: {})
285
- args = build_arguments(binding)
286
- payload_keys = [
287
- 'admin',
288
- 'age',
289
- 'avatar3DURL',
290
- 'avatar3DURLType',
291
- 'avatarURL',
292
- 'birthDate',
293
- 'couponCode',
294
- 'creationTimestamp',
295
- 'dontSendInvitationEmail',
296
- 'eMail',
297
- 'enableBadges',
298
- 'enableBoardOfExperts',
299
- 'enableDCMIntegration',
300
- 'enableDeepThought',
301
- 'enableMemoriCreation',
302
- 'enableVirtualSpaces',
303
- 'flowID',
304
- 'lastChangeTimestamp',
305
- 'maxCompletions',
306
- 'maxFreeSessions',
307
- 'maxImportSize',
308
- 'maxMemori',
309
- 'monthCompletions',
310
- 'monthDeepThoughtCompletions',
311
- 'monthDeepThoughtValidSessions',
312
- 'monthImportedSize',
313
- 'monthSessions',
314
- 'monthValidSessions',
315
- 'newPassword',
316
- 'newsletterSubscribed',
317
- 'nonFreeSessionCost',
318
- 'notificationPrefs',
319
- 'numMemori',
320
- 'pAndCUAcceptanceDate',
321
- 'pAndCUAccepted',
322
- 'password',
323
- 'paying',
324
- 'referral',
325
- 'superAdmin',
326
- 'tenant',
327
- 'tnCAndPPAcceptanceDate',
328
- 'tnCAndPPAccepted',
329
- 'userID',
330
- 'userName',
331
- 'verificationCode',
332
- ]
333
- payload_required_keys = %w[]
334
- validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
335
-
336
- exec_http_request('post', '/api/v2/User/{strToken}', **args)
337
- end
338
-
339
- # `GET /api/v2/User/{strToken}/{strUserID}`
340
- #
341
- # Gets the details of a User object.
342
- #
343
- #
344
- # @param [string] strToken The login token. required
345
- #
346
- # @param [string] strUserID The User object ID. required
347
- #
348
- # `get_user_by_id(strToken:, strUserID:)`
349
- def self.get_user_by_id(strToken:, strUserID:)
350
- args = build_arguments(binding)
351
-
352
- exec_http_request('get', '/api/v2/User/{strToken}/{strUserID}', **args)
353
- end
354
-
355
- # `PATCH /api/v2/User/{strToken}/{strUserID}`
356
- #
357
- # Updates the details of a User object (including its password).
358
- #
359
- #
360
- # @param [string] strToken The login token. required
361
- #
362
- # @param [string] strUserID The User object ID. required
363
- #
364
- # @param [Hash] payload request payload. optional
365
- #
366
- # @param [String] payload.tenant . optional
367
- #
368
- # @param [String] payload.userID . optional
369
- #
370
- # @param [String] payload.userName . optional
371
- #
372
- # @param [String] payload.password . optional
373
- #
374
- # @param [String] payload.newPassword . optional
375
- #
376
- # @param [String] payload.eMail . optional
377
- #
378
- # @param [String] payload.avatarURL . optional
379
- #
380
- # @param [String] payload.avatar3DURL . optional
381
- #
382
- # @param [String] payload.avatar3DURLType . optional
383
- #
384
- # @param [Boolean] payload.dontSendInvitationEmail . optional
385
- #
386
- # @param [String] payload.referral . optional
387
- #
388
- # @param [String] payload.couponCode . optional
389
- #
390
- # @param [Boolean] payload.newsletterSubscribed . optional
391
- #
392
- # @param [Array] payload.notificationPrefs . optional
393
- #
394
- # @param [Boolean] payload.admin . optional
395
- #
396
- # @param [Boolean] payload.superAdmin . optional
397
- #
398
- # @param [Integer] payload.numMemori . optional
399
- #
400
- # @param [Integer] payload.maxMemori . optional
401
- #
402
- # @param [Integer] payload.monthSessions . optional
403
- #
404
- # @param [Integer] payload.monthValidSessions . optional
405
- #
406
- # @param [Integer] payload.monthDeepThoughtValidSessions . optional
407
- #
408
- # @param [Integer] payload.maxFreeSessions . optional
409
- #
410
- # @param [Number] payload.nonFreeSessionCost . optional
411
- #
412
- # @param [Integer] payload.monthCompletions . optional
413
- #
414
- # @param [Integer] payload.monthDeepThoughtCompletions . optional
415
- #
416
- # @param [Integer] payload.monthImportedSize . optional
417
- #
418
- # @param [Integer] payload.maxCompletions . optional
419
- #
420
- # @param [Integer] payload.maxImportSize . optional
421
- #
422
- # @param [Boolean] payload.paying . optional
423
- #
424
- # @param [Boolean] payload.enableMemoriCreation . optional
425
- #
426
- # @param [Boolean] payload.enableBoardOfExperts . optional
427
- #
428
- # @param [Boolean] payload.enableDCMIntegration . optional
429
- #
430
- # @param [Boolean] payload.enableBadges . optional
431
- #
432
- # @param [Boolean] payload.enableDeepThought . optional
433
- #
434
- # @param [Boolean] payload.enableVirtualSpaces . optional
435
- #
436
- # @param [String] payload.birthDate . optional
437
- #
438
- # @param [Integer] payload.age . optional
439
- #
440
- # @param [Boolean] payload.tnCAndPPAccepted . optional
441
- #
442
- # @param [String] payload.tnCAndPPAcceptanceDate . optional
443
- #
444
- # @param [Boolean] payload.pAndCUAccepted . optional
445
- #
446
- # @param [String] payload.pAndCUAcceptanceDate . optional
447
- #
448
- # @param [String] payload.verificationCode . optional
449
- #
450
- # @param [String] payload.flowID . optional
451
- #
452
- # @param [String] payload.creationTimestamp . optional
453
- #
454
- # @param [String] payload.lastChangeTimestamp . optional
455
- #
456
- # `update_user(strToken:, strUserID:, payload: {})`
457
- def self.update_user(strToken:, strUserID:, payload: {})
458
- args = build_arguments(binding)
459
- payload_keys = [
460
- 'admin',
461
- 'age',
462
- 'avatar3DURL',
463
- 'avatar3DURLType',
464
- 'avatarURL',
465
- 'birthDate',
466
- 'couponCode',
467
- 'creationTimestamp',
468
- 'dontSendInvitationEmail',
469
- 'eMail',
470
- 'enableBadges',
471
- 'enableBoardOfExperts',
472
- 'enableDCMIntegration',
473
- 'enableDeepThought',
474
- 'enableMemoriCreation',
475
- 'enableVirtualSpaces',
476
- 'flowID',
477
- 'lastChangeTimestamp',
478
- 'maxCompletions',
479
- 'maxFreeSessions',
480
- 'maxImportSize',
481
- 'maxMemori',
482
- 'monthCompletions',
483
- 'monthDeepThoughtCompletions',
484
- 'monthDeepThoughtValidSessions',
485
- 'monthImportedSize',
486
- 'monthSessions',
487
- 'monthValidSessions',
488
- 'newPassword',
489
- 'newsletterSubscribed',
490
- 'nonFreeSessionCost',
491
- 'notificationPrefs',
492
- 'numMemori',
493
- 'pAndCUAcceptanceDate',
494
- 'pAndCUAccepted',
495
- 'password',
496
- 'paying',
497
- 'referral',
498
- 'superAdmin',
499
- 'tenant',
500
- 'tnCAndPPAcceptanceDate',
501
- 'tnCAndPPAccepted',
502
- 'userID',
503
- 'userName',
504
- 'verificationCode',
505
- ]
506
- payload_required_keys = %w[]
507
- validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
508
-
509
- exec_http_request('patch', '/api/v2/User/{strToken}/{strUserID}', **args)
510
- end
511
-
512
- # `DELETE /api/v2/User/{strToken}/{strUserID}`
513
- #
514
- # Deletes a User object.
515
- #
516
- #
517
- # @param [string] strToken The login token. required
518
- #
519
- # @param [string] strUserID The User object ID. required
520
- #
521
- # `delete_user(strToken:, strUserID:)`
522
- def self.delete_user(strToken:, strUserID:)
523
- args = build_arguments(binding)
524
-
525
- exec_http_request('delete', '/api/v2/User/{strToken}/{strUserID}', **args)
526
- end
527
-
528
- # `GET /api/v2/Users/{strToken}`
529
- #
530
- # Gets a list of all the existing User objects.
531
- #
532
- #
533
- # @param [string] strToken The login token. required
534
- #
535
- # `list_users(strToken:)`
536
- def self.list_users(strToken:)
537
- args = build_arguments(binding)
538
-
539
- exec_http_request('get', '/api/v2/Users/{strToken}', **args)
540
- end
541
-
542
- # `GET /api/v2/Users/{strToken}/{from}/{howMany}`
543
- #
544
- # Gets a paginated list of the existing User objects.
545
- #
546
- #
547
- # @param [string] strToken The login token. required
548
- #
549
- # @param [integer] from The index of the starting user to get. required
550
- #
551
- # @param [integer] howMany How many users to get. required
552
- #
553
- # `list_users_paginated(strToken:, from:, howMany:)`
554
- def self.list_users_paginated(strToken:, from:, howMany:)
555
- args = build_arguments(binding)
556
-
557
- exec_http_request('get', '/api/v2/Users/{strToken}/{from}/{howMany}', **args)
558
- end
559
-
560
- # `POST /api/v2/FilterUsers/{strToken}`
561
- #
562
- # Returns a paginated list of User objects filtered by the specified criteria
563
- #
564
- #
565
- # @param [string] strToken The login token. required
566
- #
567
- # @param [Hash] payload request payload. optional
568
- #
569
- # @param [String] payload.periodFrom . optional
570
- #
571
- # @param [String] payload.periodTo . optional
572
- #
573
- # @param [String] payload.tenantName . optional
574
- #
575
- # @param [String] payload.text . optional
576
- #
577
- # @param [Integer] payload.numberOfResults . optional
578
- #
579
- # @param [Integer] payload.startFrom . optional
580
- #
581
- # @param [String] payload.orderBy . optional
582
- #
583
- # `filter_users(strToken:, payload: {})`
584
- def self.filter_users(strToken:, payload: {})
585
- args = build_arguments(binding)
586
- payload_keys = [
587
- 'numberOfResults',
588
- 'orderBy',
589
- 'periodFrom',
590
- 'periodTo',
591
- 'startFrom',
592
- 'tenantName',
593
- 'text',
594
- ]
595
- payload_required_keys = %w[]
596
- validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
597
-
598
- exec_http_request('post', '/api/v2/FilterUsers/{strToken}', **args)
599
- end
600
-
601
- # `POST /api/v2/User`
602
- #
603
- # Registers a new user.
604
- #
605
- #
606
- # @param [Hash] payload request payload. optional
607
- #
608
- # @param [String] payload.tenant . optional
609
- #
610
- # @param [String] payload.userID . optional
611
- #
612
- # @param [String] payload.userName . optional
613
- #
614
- # @param [String] payload.password . optional
615
- #
616
- # @param [String] payload.newPassword . optional
617
- #
618
- # @param [String] payload.eMail . optional
619
- #
620
- # @param [String] payload.avatarURL . optional
621
- #
622
- # @param [String] payload.avatar3DURL . optional
623
- #
624
- # @param [String] payload.avatar3DURLType . optional
625
- #
626
- # @param [Boolean] payload.dontSendInvitationEmail . optional
627
- #
628
- # @param [String] payload.referral . optional
629
- #
630
- # @param [String] payload.couponCode . optional
631
- #
632
- # @param [Boolean] payload.newsletterSubscribed . optional
633
- #
634
- # @param [Array] payload.notificationPrefs . optional
635
- #
636
- # @param [Boolean] payload.admin . optional
637
- #
638
- # @param [Boolean] payload.superAdmin . optional
639
- #
640
- # @param [Integer] payload.numMemori . optional
641
- #
642
- # @param [Integer] payload.maxMemori . optional
643
- #
644
- # @param [Integer] payload.monthSessions . optional
645
- #
646
- # @param [Integer] payload.monthValidSessions . optional
647
- #
648
- # @param [Integer] payload.monthDeepThoughtValidSessions . optional
649
- #
650
- # @param [Integer] payload.maxFreeSessions . optional
651
- #
652
- # @param [Number] payload.nonFreeSessionCost . optional
653
- #
654
- # @param [Integer] payload.monthCompletions . optional
655
- #
656
- # @param [Integer] payload.monthDeepThoughtCompletions . optional
657
- #
658
- # @param [Integer] payload.monthImportedSize . optional
659
- #
660
- # @param [Integer] payload.maxCompletions . optional
661
- #
662
- # @param [Integer] payload.maxImportSize . optional
663
- #
664
- # @param [Boolean] payload.paying . optional
665
- #
666
- # @param [Boolean] payload.enableMemoriCreation . optional
667
- #
668
- # @param [Boolean] payload.enableBoardOfExperts . optional
669
- #
670
- # @param [Boolean] payload.enableDCMIntegration . optional
671
- #
672
- # @param [Boolean] payload.enableBadges . optional
673
- #
674
- # @param [Boolean] payload.enableDeepThought . optional
675
- #
676
- # @param [Boolean] payload.enableVirtualSpaces . optional
677
- #
678
- # @param [String] payload.birthDate . optional
679
- #
680
- # @param [Integer] payload.age . optional
681
- #
682
- # @param [Boolean] payload.tnCAndPPAccepted . optional
683
- #
684
- # @param [String] payload.tnCAndPPAcceptanceDate . optional
685
- #
686
- # @param [Boolean] payload.pAndCUAccepted . optional
687
- #
688
- # @param [String] payload.pAndCUAcceptanceDate . optional
689
- #
690
- # @param [String] payload.verificationCode . optional
691
- #
692
- # @param [String] payload.flowID . optional
693
- #
694
- # @param [String] payload.creationTimestamp . optional
695
- #
696
- # @param [String] payload.lastChangeTimestamp . optional
697
- #
698
- # `register_user(payload: {})`
699
- def self.register_user(payload: {})
700
- args = build_arguments(binding)
701
- payload_keys = [
702
- 'admin',
703
- 'age',
704
- 'avatar3DURL',
705
- 'avatar3DURLType',
706
- 'avatarURL',
707
- 'birthDate',
708
- 'couponCode',
709
- 'creationTimestamp',
710
- 'dontSendInvitationEmail',
711
- 'eMail',
712
- 'enableBadges',
713
- 'enableBoardOfExperts',
714
- 'enableDCMIntegration',
715
- 'enableDeepThought',
716
- 'enableMemoriCreation',
717
- 'enableVirtualSpaces',
718
- 'flowID',
719
- 'lastChangeTimestamp',
720
- 'maxCompletions',
721
- 'maxFreeSessions',
722
- 'maxImportSize',
723
- 'maxMemori',
724
- 'monthCompletions',
725
- 'monthDeepThoughtCompletions',
726
- 'monthDeepThoughtValidSessions',
727
- 'monthImportedSize',
728
- 'monthSessions',
729
- 'monthValidSessions',
730
- 'newPassword',
731
- 'newsletterSubscribed',
732
- 'nonFreeSessionCost',
733
- 'notificationPrefs',
734
- 'numMemori',
735
- 'pAndCUAcceptanceDate',
736
- 'pAndCUAccepted',
737
- 'password',
738
- 'paying',
739
- 'referral',
740
- 'superAdmin',
741
- 'tenant',
742
- 'tnCAndPPAcceptanceDate',
743
- 'tnCAndPPAccepted',
744
- 'userID',
745
- 'userName',
746
- 'verificationCode',
747
- ]
748
- payload_required_keys = %w[]
749
- validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
750
-
751
- exec_http_request('post', '/api/v2/User', **args)
752
- end
753
-
754
- # `POST /api/v2/ResendVerificationCode`
755
- #
756
- # Re-sends the verification code to confirm a pending User registration.
757
- #
758
- #
759
- # @param [Hash] payload request payload. optional
760
- #
761
- # @param [String] payload.tenant . optional
762
- #
763
- # @param [String] payload.userID . optional
764
- #
765
- # @param [String] payload.userName . optional
766
- #
767
- # @param [String] payload.password . optional
768
- #
769
- # @param [String] payload.newPassword . optional
770
- #
771
- # @param [String] payload.eMail . optional
772
- #
773
- # @param [String] payload.avatarURL . optional
774
- #
775
- # @param [String] payload.avatar3DURL . optional
776
- #
777
- # @param [String] payload.avatar3DURLType . optional
778
- #
779
- # @param [Boolean] payload.dontSendInvitationEmail . optional
780
- #
781
- # @param [String] payload.referral . optional
782
- #
783
- # @param [String] payload.couponCode . optional
784
- #
785
- # @param [Boolean] payload.newsletterSubscribed . optional
786
- #
787
- # @param [Array] payload.notificationPrefs . optional
788
- #
789
- # @param [Boolean] payload.admin . optional
790
- #
791
- # @param [Boolean] payload.superAdmin . optional
792
- #
793
- # @param [Integer] payload.numMemori . optional
794
- #
795
- # @param [Integer] payload.maxMemori . optional
796
- #
797
- # @param [Integer] payload.monthSessions . optional
798
- #
799
- # @param [Integer] payload.monthValidSessions . optional
800
- #
801
- # @param [Integer] payload.monthDeepThoughtValidSessions . optional
802
- #
803
- # @param [Integer] payload.maxFreeSessions . optional
804
- #
805
- # @param [Number] payload.nonFreeSessionCost . optional
806
- #
807
- # @param [Integer] payload.monthCompletions . optional
808
- #
809
- # @param [Integer] payload.monthDeepThoughtCompletions . optional
810
- #
811
- # @param [Integer] payload.monthImportedSize . optional
812
- #
813
- # @param [Integer] payload.maxCompletions . optional
814
- #
815
- # @param [Integer] payload.maxImportSize . optional
816
- #
817
- # @param [Boolean] payload.paying . optional
818
- #
819
- # @param [Boolean] payload.enableMemoriCreation . optional
820
- #
821
- # @param [Boolean] payload.enableBoardOfExperts . optional
822
- #
823
- # @param [Boolean] payload.enableDCMIntegration . optional
824
- #
825
- # @param [Boolean] payload.enableBadges . optional
826
- #
827
- # @param [Boolean] payload.enableDeepThought . optional
828
- #
829
- # @param [Boolean] payload.enableVirtualSpaces . optional
830
- #
831
- # @param [String] payload.birthDate . optional
832
- #
833
- # @param [Integer] payload.age . optional
834
- #
835
- # @param [Boolean] payload.tnCAndPPAccepted . optional
836
- #
837
- # @param [String] payload.tnCAndPPAcceptanceDate . optional
838
- #
839
- # @param [Boolean] payload.pAndCUAccepted . optional
840
- #
841
- # @param [String] payload.pAndCUAcceptanceDate . optional
842
- #
843
- # @param [String] payload.verificationCode . optional
844
- #
845
- # @param [String] payload.flowID . optional
846
- #
847
- # @param [String] payload.creationTimestamp . optional
848
- #
849
- # @param [String] payload.lastChangeTimestamp . optional
850
- #
851
- # `resend_verification_code(payload: {})`
852
- def self.resend_verification_code(payload: {})
853
- args = build_arguments(binding)
854
- payload_keys = [
855
- 'admin',
856
- 'age',
857
- 'avatar3DURL',
858
- 'avatar3DURLType',
859
- 'avatarURL',
860
- 'birthDate',
861
- 'couponCode',
862
- 'creationTimestamp',
863
- 'dontSendInvitationEmail',
864
- 'eMail',
865
- 'enableBadges',
866
- 'enableBoardOfExperts',
867
- 'enableDCMIntegration',
868
- 'enableDeepThought',
869
- 'enableMemoriCreation',
870
- 'enableVirtualSpaces',
871
- 'flowID',
872
- 'lastChangeTimestamp',
873
- 'maxCompletions',
874
- 'maxFreeSessions',
875
- 'maxImportSize',
876
- 'maxMemori',
877
- 'monthCompletions',
878
- 'monthDeepThoughtCompletions',
879
- 'monthDeepThoughtValidSessions',
880
- 'monthImportedSize',
881
- 'monthSessions',
882
- 'monthValidSessions',
883
- 'newPassword',
884
- 'newsletterSubscribed',
885
- 'nonFreeSessionCost',
886
- 'notificationPrefs',
887
- 'numMemori',
888
- 'pAndCUAcceptanceDate',
889
- 'pAndCUAccepted',
890
- 'password',
891
- 'paying',
892
- 'referral',
893
- 'superAdmin',
894
- 'tenant',
895
- 'tnCAndPPAcceptanceDate',
896
- 'tnCAndPPAccepted',
897
- 'userID',
898
- 'userName',
899
- 'verificationCode',
900
- ]
901
- payload_required_keys = %w[]
902
- validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
903
-
904
- exec_http_request('post', '/api/v2/ResendVerificationCode', **args)
905
- end
906
-
907
- # `POST /api/v2/UserConfirm`
908
- #
909
- # Confirms the registration of a User and performs a Login.
910
- #
911
- #
912
- # @param [Hash] payload request payload. optional
913
- #
914
- # @param [String] payload.tenant . optional
915
- #
916
- # @param [String] payload.userID . optional
917
- #
918
- # @param [String] payload.userName . optional
919
- #
920
- # @param [String] payload.password . optional
921
- #
922
- # @param [String] payload.newPassword . optional
923
- #
924
- # @param [String] payload.eMail . optional
925
- #
926
- # @param [String] payload.avatarURL . optional
927
- #
928
- # @param [String] payload.avatar3DURL . optional
929
- #
930
- # @param [String] payload.avatar3DURLType . optional
931
- #
932
- # @param [Boolean] payload.dontSendInvitationEmail . optional
933
- #
934
- # @param [String] payload.referral . optional
935
- #
936
- # @param [String] payload.couponCode . optional
937
- #
938
- # @param [Boolean] payload.newsletterSubscribed . optional
939
- #
940
- # @param [Array] payload.notificationPrefs . optional
941
- #
942
- # @param [Boolean] payload.admin . optional
943
- #
944
- # @param [Boolean] payload.superAdmin . optional
945
- #
946
- # @param [Integer] payload.numMemori . optional
947
- #
948
- # @param [Integer] payload.maxMemori . optional
949
- #
950
- # @param [Integer] payload.monthSessions . optional
951
- #
952
- # @param [Integer] payload.monthValidSessions . optional
953
- #
954
- # @param [Integer] payload.monthDeepThoughtValidSessions . optional
955
- #
956
- # @param [Integer] payload.maxFreeSessions . optional
957
- #
958
- # @param [Number] payload.nonFreeSessionCost . optional
959
- #
960
- # @param [Integer] payload.monthCompletions . optional
961
- #
962
- # @param [Integer] payload.monthDeepThoughtCompletions . optional
963
- #
964
- # @param [Integer] payload.monthImportedSize . optional
965
- #
966
- # @param [Integer] payload.maxCompletions . optional
967
- #
968
- # @param [Integer] payload.maxImportSize . optional
969
- #
970
- # @param [Boolean] payload.paying . optional
971
- #
972
- # @param [Boolean] payload.enableMemoriCreation . optional
973
- #
974
- # @param [Boolean] payload.enableBoardOfExperts . optional
975
- #
976
- # @param [Boolean] payload.enableDCMIntegration . optional
977
- #
978
- # @param [Boolean] payload.enableBadges . optional
979
- #
980
- # @param [Boolean] payload.enableDeepThought . optional
981
- #
982
- # @param [Boolean] payload.enableVirtualSpaces . optional
983
- #
984
- # @param [String] payload.birthDate . optional
985
- #
986
- # @param [Integer] payload.age . optional
987
- #
988
- # @param [Boolean] payload.tnCAndPPAccepted . optional
989
- #
990
- # @param [String] payload.tnCAndPPAcceptanceDate . optional
991
- #
992
- # @param [Boolean] payload.pAndCUAccepted . optional
993
- #
994
- # @param [String] payload.pAndCUAcceptanceDate . optional
995
- #
996
- # @param [String] payload.verificationCode . optional
997
- #
998
- # @param [String] payload.flowID . optional
999
- #
1000
- # @param [String] payload.creationTimestamp . optional
1001
- #
1002
- # @param [String] payload.lastChangeTimestamp . optional
1003
- #
1004
- # `confirm_registration(payload: {})`
1005
- def self.confirm_registration(payload: {})
1006
- args = build_arguments(binding)
1007
- payload_keys = [
1008
- 'admin',
1009
- 'age',
1010
- 'avatar3DURL',
1011
- 'avatar3DURLType',
1012
- 'avatarURL',
1013
- 'birthDate',
1014
- 'couponCode',
1015
- 'creationTimestamp',
1016
- 'dontSendInvitationEmail',
1017
- 'eMail',
1018
- 'enableBadges',
1019
- 'enableBoardOfExperts',
1020
- 'enableDCMIntegration',
1021
- 'enableDeepThought',
1022
- 'enableMemoriCreation',
1023
- 'enableVirtualSpaces',
1024
- 'flowID',
1025
- 'lastChangeTimestamp',
1026
- 'maxCompletions',
1027
- 'maxFreeSessions',
1028
- 'maxImportSize',
1029
- 'maxMemori',
1030
- 'monthCompletions',
1031
- 'monthDeepThoughtCompletions',
1032
- 'monthDeepThoughtValidSessions',
1033
- 'monthImportedSize',
1034
- 'monthSessions',
1035
- 'monthValidSessions',
1036
- 'newPassword',
1037
- 'newsletterSubscribed',
1038
- 'nonFreeSessionCost',
1039
- 'notificationPrefs',
1040
- 'numMemori',
1041
- 'pAndCUAcceptanceDate',
1042
- 'pAndCUAccepted',
1043
- 'password',
1044
- 'paying',
1045
- 'referral',
1046
- 'superAdmin',
1047
- 'tenant',
1048
- 'tnCAndPPAcceptanceDate',
1049
- 'tnCAndPPAccepted',
1050
- 'userID',
1051
- 'userName',
1052
- 'verificationCode',
1053
- ]
1054
- payload_required_keys = %w[]
1055
- validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
1056
-
1057
- exec_http_request('post', '/api/v2/UserConfirm', **args)
1058
- end
1059
-
1060
- # `POST /api/v2/ResetPassword`
1061
- #
1062
- # Resets a User's password.
1063
- #
1064
- #
1065
- # @param [Hash] payload request payload. optional
1066
- #
1067
- # @param [String] payload.tenant . optional
1068
- #
1069
- # @param [String] payload.userID . optional
1070
- #
1071
- # @param [String] payload.userName . optional
1072
- #
1073
- # @param [String] payload.password . optional
1074
- #
1075
- # @param [String] payload.newPassword . optional
1076
- #
1077
- # @param [String] payload.eMail . optional
1078
- #
1079
- # @param [String] payload.avatarURL . optional
1080
- #
1081
- # @param [String] payload.avatar3DURL . optional
1082
- #
1083
- # @param [String] payload.avatar3DURLType . optional
1084
- #
1085
- # @param [Boolean] payload.dontSendInvitationEmail . optional
1086
- #
1087
- # @param [String] payload.referral . optional
1088
- #
1089
- # @param [String] payload.couponCode . optional
1090
- #
1091
- # @param [Boolean] payload.newsletterSubscribed . optional
1092
- #
1093
- # @param [Array] payload.notificationPrefs . optional
1094
- #
1095
- # @param [Boolean] payload.admin . optional
1096
- #
1097
- # @param [Boolean] payload.superAdmin . optional
1098
- #
1099
- # @param [Integer] payload.numMemori . optional
1100
- #
1101
- # @param [Integer] payload.maxMemori . optional
1102
- #
1103
- # @param [Integer] payload.monthSessions . optional
1104
- #
1105
- # @param [Integer] payload.monthValidSessions . optional
1106
- #
1107
- # @param [Integer] payload.monthDeepThoughtValidSessions . optional
1108
- #
1109
- # @param [Integer] payload.maxFreeSessions . optional
1110
- #
1111
- # @param [Number] payload.nonFreeSessionCost . optional
1112
- #
1113
- # @param [Integer] payload.monthCompletions . optional
1114
- #
1115
- # @param [Integer] payload.monthDeepThoughtCompletions . optional
1116
- #
1117
- # @param [Integer] payload.monthImportedSize . optional
1118
- #
1119
- # @param [Integer] payload.maxCompletions . optional
1120
- #
1121
- # @param [Integer] payload.maxImportSize . optional
1122
- #
1123
- # @param [Boolean] payload.paying . optional
1124
- #
1125
- # @param [Boolean] payload.enableMemoriCreation . optional
1126
- #
1127
- # @param [Boolean] payload.enableBoardOfExperts . optional
1128
- #
1129
- # @param [Boolean] payload.enableDCMIntegration . optional
1130
- #
1131
- # @param [Boolean] payload.enableBadges . optional
1132
- #
1133
- # @param [Boolean] payload.enableDeepThought . optional
1134
- #
1135
- # @param [Boolean] payload.enableVirtualSpaces . optional
1136
- #
1137
- # @param [String] payload.birthDate . optional
1138
- #
1139
- # @param [Integer] payload.age . optional
1140
- #
1141
- # @param [Boolean] payload.tnCAndPPAccepted . optional
1142
- #
1143
- # @param [String] payload.tnCAndPPAcceptanceDate . optional
1144
- #
1145
- # @param [Boolean] payload.pAndCUAccepted . optional
1146
- #
1147
- # @param [String] payload.pAndCUAcceptanceDate . optional
1148
- #
1149
- # @param [String] payload.verificationCode . optional
1150
- #
1151
- # @param [String] payload.flowID . optional
1152
- #
1153
- # @param [String] payload.creationTimestamp . optional
1154
- #
1155
- # @param [String] payload.lastChangeTimestamp . optional
1156
- #
1157
- # `reset_user_password(payload: {})`
1158
- def self.reset_user_password(payload: {})
1159
- args = build_arguments(binding)
1160
- payload_keys = [
1161
- 'admin',
1162
- 'age',
1163
- 'avatar3DURL',
1164
- 'avatar3DURLType',
1165
- 'avatarURL',
1166
- 'birthDate',
1167
- 'couponCode',
1168
- 'creationTimestamp',
1169
- 'dontSendInvitationEmail',
1170
- 'eMail',
1171
- 'enableBadges',
1172
- 'enableBoardOfExperts',
1173
- 'enableDCMIntegration',
1174
- 'enableDeepThought',
1175
- 'enableMemoriCreation',
1176
- 'enableVirtualSpaces',
1177
- 'flowID',
1178
- 'lastChangeTimestamp',
1179
- 'maxCompletions',
1180
- 'maxFreeSessions',
1181
- 'maxImportSize',
1182
- 'maxMemori',
1183
- 'monthCompletions',
1184
- 'monthDeepThoughtCompletions',
1185
- 'monthDeepThoughtValidSessions',
1186
- 'monthImportedSize',
1187
- 'monthSessions',
1188
- 'monthValidSessions',
1189
- 'newPassword',
1190
- 'newsletterSubscribed',
1191
- 'nonFreeSessionCost',
1192
- 'notificationPrefs',
1193
- 'numMemori',
1194
- 'pAndCUAcceptanceDate',
1195
- 'pAndCUAccepted',
1196
- 'password',
1197
- 'paying',
1198
- 'referral',
1199
- 'superAdmin',
1200
- 'tenant',
1201
- 'tnCAndPPAcceptanceDate',
1202
- 'tnCAndPPAccepted',
1203
- 'userID',
1204
- 'userName',
1205
- 'verificationCode',
1206
- ]
1207
- payload_required_keys = %w[]
1208
- validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
1209
-
1210
- exec_http_request('post', '/api/v2/ResetPassword', **args)
1211
- end
1212
-
1213
- # `POST /api/v2/ResetConfirm`
1214
- #
1215
- # Confirms the password reset of a User and performs a Login.
1216
- #
1217
- #
1218
- # @param [Hash] payload request payload. optional
1219
- #
1220
- # @param [String] payload.tenant . optional
1221
- #
1222
- # @param [String] payload.userID . optional
1223
- #
1224
- # @param [String] payload.userName . optional
1225
- #
1226
- # @param [String] payload.password . optional
1227
- #
1228
- # @param [String] payload.newPassword . optional
1229
- #
1230
- # @param [String] payload.eMail . optional
1231
- #
1232
- # @param [String] payload.avatarURL . optional
1233
- #
1234
- # @param [String] payload.avatar3DURL . optional
1235
- #
1236
- # @param [String] payload.avatar3DURLType . optional
1237
- #
1238
- # @param [Boolean] payload.dontSendInvitationEmail . optional
1239
- #
1240
- # @param [String] payload.referral . optional
1241
- #
1242
- # @param [String] payload.couponCode . optional
1243
- #
1244
- # @param [Boolean] payload.newsletterSubscribed . optional
1245
- #
1246
- # @param [Array] payload.notificationPrefs . optional
1247
- #
1248
- # @param [Boolean] payload.admin . optional
1249
- #
1250
- # @param [Boolean] payload.superAdmin . optional
1251
- #
1252
- # @param [Integer] payload.numMemori . optional
1253
- #
1254
- # @param [Integer] payload.maxMemori . optional
1255
- #
1256
- # @param [Integer] payload.monthSessions . optional
1257
- #
1258
- # @param [Integer] payload.monthValidSessions . optional
1259
- #
1260
- # @param [Integer] payload.monthDeepThoughtValidSessions . optional
1261
- #
1262
- # @param [Integer] payload.maxFreeSessions . optional
1263
- #
1264
- # @param [Number] payload.nonFreeSessionCost . optional
1265
- #
1266
- # @param [Integer] payload.monthCompletions . optional
1267
- #
1268
- # @param [Integer] payload.monthDeepThoughtCompletions . optional
1269
- #
1270
- # @param [Integer] payload.monthImportedSize . optional
1271
- #
1272
- # @param [Integer] payload.maxCompletions . optional
1273
- #
1274
- # @param [Integer] payload.maxImportSize . optional
1275
- #
1276
- # @param [Boolean] payload.paying . optional
1277
- #
1278
- # @param [Boolean] payload.enableMemoriCreation . optional
1279
- #
1280
- # @param [Boolean] payload.enableBoardOfExperts . optional
1281
- #
1282
- # @param [Boolean] payload.enableDCMIntegration . optional
1283
- #
1284
- # @param [Boolean] payload.enableBadges . optional
1285
- #
1286
- # @param [Boolean] payload.enableDeepThought . optional
1287
- #
1288
- # @param [Boolean] payload.enableVirtualSpaces . optional
1289
- #
1290
- # @param [String] payload.birthDate . optional
1291
- #
1292
- # @param [Integer] payload.age . optional
1293
- #
1294
- # @param [Boolean] payload.tnCAndPPAccepted . optional
1295
- #
1296
- # @param [String] payload.tnCAndPPAcceptanceDate . optional
1297
- #
1298
- # @param [Boolean] payload.pAndCUAccepted . optional
1299
- #
1300
- # @param [String] payload.pAndCUAcceptanceDate . optional
1301
- #
1302
- # @param [String] payload.verificationCode . optional
1303
- #
1304
- # @param [String] payload.flowID . optional
1305
- #
1306
- # @param [String] payload.creationTimestamp . optional
1307
- #
1308
- # @param [String] payload.lastChangeTimestamp . optional
1309
- #
1310
- # `confirm_password_reset(payload: {})`
1311
- def self.confirm_password_reset(payload: {})
1312
- args = build_arguments(binding)
1313
- payload_keys = [
1314
- 'admin',
1315
- 'age',
1316
- 'avatar3DURL',
1317
- 'avatar3DURLType',
1318
- 'avatarURL',
1319
- 'birthDate',
1320
- 'couponCode',
1321
- 'creationTimestamp',
1322
- 'dontSendInvitationEmail',
1323
- 'eMail',
1324
- 'enableBadges',
1325
- 'enableBoardOfExperts',
1326
- 'enableDCMIntegration',
1327
- 'enableDeepThought',
1328
- 'enableMemoriCreation',
1329
- 'enableVirtualSpaces',
1330
- 'flowID',
1331
- 'lastChangeTimestamp',
1332
- 'maxCompletions',
1333
- 'maxFreeSessions',
1334
- 'maxImportSize',
1335
- 'maxMemori',
1336
- 'monthCompletions',
1337
- 'monthDeepThoughtCompletions',
1338
- 'monthDeepThoughtValidSessions',
1339
- 'monthImportedSize',
1340
- 'monthSessions',
1341
- 'monthValidSessions',
1342
- 'newPassword',
1343
- 'newsletterSubscribed',
1344
- 'nonFreeSessionCost',
1345
- 'notificationPrefs',
1346
- 'numMemori',
1347
- 'pAndCUAcceptanceDate',
1348
- 'pAndCUAccepted',
1349
- 'password',
1350
- 'paying',
1351
- 'referral',
1352
- 'superAdmin',
1353
- 'tenant',
1354
- 'tnCAndPPAcceptanceDate',
1355
- 'tnCAndPPAccepted',
1356
- 'userID',
1357
- 'userName',
1358
- 'verificationCode',
1359
- ]
1360
- payload_required_keys = %w[]
1361
- validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
1362
-
1363
- exec_http_request('post', '/api/v2/ResetConfirm', **args)
1364
- end
1365
-
1366
- # `POST /api/v2/RecoverUserName`
1367
- #
1368
- # Recovers a User's name and sends it to their configured e-mail.
1369
- #
1370
- #
1371
- # @param [Hash] payload request payload. optional
1372
- #
1373
- # @param [String] payload.tenant . optional
1374
- #
1375
- # @param [String] payload.userID . optional
1376
- #
1377
- # @param [String] payload.userName . optional
1378
- #
1379
- # @param [String] payload.password . optional
1380
- #
1381
- # @param [String] payload.newPassword . optional
1382
- #
1383
- # @param [String] payload.eMail . optional
1384
- #
1385
- # @param [String] payload.avatarURL . optional
1386
- #
1387
- # @param [String] payload.avatar3DURL . optional
1388
- #
1389
- # @param [String] payload.avatar3DURLType . optional
1390
- #
1391
- # @param [Boolean] payload.dontSendInvitationEmail . optional
1392
- #
1393
- # @param [String] payload.referral . optional
1394
- #
1395
- # @param [String] payload.couponCode . optional
1396
- #
1397
- # @param [Boolean] payload.newsletterSubscribed . optional
1398
- #
1399
- # @param [Array] payload.notificationPrefs . optional
1400
- #
1401
- # @param [Boolean] payload.admin . optional
1402
- #
1403
- # @param [Boolean] payload.superAdmin . optional
1404
- #
1405
- # @param [Integer] payload.numMemori . optional
1406
- #
1407
- # @param [Integer] payload.maxMemori . optional
1408
- #
1409
- # @param [Integer] payload.monthSessions . optional
1410
- #
1411
- # @param [Integer] payload.monthValidSessions . optional
1412
- #
1413
- # @param [Integer] payload.monthDeepThoughtValidSessions . optional
1414
- #
1415
- # @param [Integer] payload.maxFreeSessions . optional
1416
- #
1417
- # @param [Number] payload.nonFreeSessionCost . optional
1418
- #
1419
- # @param [Integer] payload.monthCompletions . optional
1420
- #
1421
- # @param [Integer] payload.monthDeepThoughtCompletions . optional
1422
- #
1423
- # @param [Integer] payload.monthImportedSize . optional
1424
- #
1425
- # @param [Integer] payload.maxCompletions . optional
1426
- #
1427
- # @param [Integer] payload.maxImportSize . optional
1428
- #
1429
- # @param [Boolean] payload.paying . optional
1430
- #
1431
- # @param [Boolean] payload.enableMemoriCreation . optional
1432
- #
1433
- # @param [Boolean] payload.enableBoardOfExperts . optional
1434
- #
1435
- # @param [Boolean] payload.enableDCMIntegration . optional
1436
- #
1437
- # @param [Boolean] payload.enableBadges . optional
1438
- #
1439
- # @param [Boolean] payload.enableDeepThought . optional
1440
- #
1441
- # @param [Boolean] payload.enableVirtualSpaces . optional
1442
- #
1443
- # @param [String] payload.birthDate . optional
1444
- #
1445
- # @param [Integer] payload.age . optional
1446
- #
1447
- # @param [Boolean] payload.tnCAndPPAccepted . optional
1448
- #
1449
- # @param [String] payload.tnCAndPPAcceptanceDate . optional
1450
- #
1451
- # @param [Boolean] payload.pAndCUAccepted . optional
1452
- #
1453
- # @param [String] payload.pAndCUAcceptanceDate . optional
1454
- #
1455
- # @param [String] payload.verificationCode . optional
1456
- #
1457
- # @param [String] payload.flowID . optional
1458
- #
1459
- # @param [String] payload.creationTimestamp . optional
1460
- #
1461
- # @param [String] payload.lastChangeTimestamp . optional
1462
- #
1463
- # `recover_user_name(payload: {})`
1464
- def self.recover_user_name(payload: {})
1465
- args = build_arguments(binding)
1466
- payload_keys = [
1467
- 'admin',
1468
- 'age',
1469
- 'avatar3DURL',
1470
- 'avatar3DURLType',
1471
- 'avatarURL',
1472
- 'birthDate',
1473
- 'couponCode',
1474
- 'creationTimestamp',
1475
- 'dontSendInvitationEmail',
1476
- 'eMail',
1477
- 'enableBadges',
1478
- 'enableBoardOfExperts',
1479
- 'enableDCMIntegration',
1480
- 'enableDeepThought',
1481
- 'enableMemoriCreation',
1482
- 'enableVirtualSpaces',
1483
- 'flowID',
1484
- 'lastChangeTimestamp',
1485
- 'maxCompletions',
1486
- 'maxFreeSessions',
1487
- 'maxImportSize',
1488
- 'maxMemori',
1489
- 'monthCompletions',
1490
- 'monthDeepThoughtCompletions',
1491
- 'monthDeepThoughtValidSessions',
1492
- 'monthImportedSize',
1493
- 'monthSessions',
1494
- 'monthValidSessions',
1495
- 'newPassword',
1496
- 'newsletterSubscribed',
1497
- 'nonFreeSessionCost',
1498
- 'notificationPrefs',
1499
- 'numMemori',
1500
- 'pAndCUAcceptanceDate',
1501
- 'pAndCUAccepted',
1502
- 'password',
1503
- 'paying',
1504
- 'referral',
1505
- 'superAdmin',
1506
- 'tenant',
1507
- 'tnCAndPPAcceptanceDate',
1508
- 'tnCAndPPAccepted',
1509
- 'userID',
1510
- 'userName',
1511
- 'verificationCode',
1512
- ]
1513
- payload_required_keys = %w[]
1514
- validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
1515
-
1516
- exec_http_request('post', '/api/v2/RecoverUserName', **args)
1517
- end
1518
-
1519
-
1520
- end