Class: MemoriClient::Backend::V2::User

Inherits:
Resource show all
Defined in:
lib/memori_client/backend/v2/user.rb

Overview

Generated on 2025-01-27 16:56:15 +0000

Class Method Summary collapse

Methods inherited from Resource

build_url

Methods inherited from Resource

build_arguments, build_url, exec_http_request, validate_payload!

Class Method Details

.confirm_password_reset(payload: {}) ⇒ Object

‘POST /api/v2/ResetConfirm`

Confirms the password reset of a User and performs a Login.

‘confirm_password_reset(payload: {})`

Parameters:

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.tenant (String) —

    . optional

  • payload.userID (String) —

    . optional

  • payload.userName (String) —

    . optional

  • payload.password (String) —

    . optional

  • payload.newPassword (String) —

    . optional

  • payload.eMail (String) —

    . optional

  • payload.avatarURL (String) —

    . optional

  • payload.avatar3DURL (String) —

    . optional

  • payload.avatar3DURLType (String) —

    . optional

  • payload.dontSendInvitationEmail (Boolean) —

    . optional

  • payload.referral (String) —

    . optional

  • payload.couponCode (String) —

    . optional

  • payload.newsletterSubscribed (Boolean) —

    . optional

  • payload.notificationPrefs (Array) —

    . optional

  • payload.admin (Boolean) —

    . optional

  • payload.superAdmin (Boolean) —

    . optional

  • payload.numMemori (Integer) —

    . optional

  • payload.maxMemori (Integer) —

    . optional

  • payload.monthSessions (Integer) —

    . optional

  • payload.monthValidSessions (Integer) —

    . optional

  • payload.monthDeepThoughtValidSessions (Integer) —

    . optional

  • payload.maxFreeSessions (Integer) —

    . optional

  • payload.nonFreeSessionCost (Number) —

    . optional

  • payload.monthCompletions (Integer) —

    . optional

  • payload.monthDeepThoughtCompletions (Integer) —

    . optional

  • payload.monthImportedSize (Integer) —

    . optional

  • payload.maxCompletions (Integer) —

    . optional

  • payload.maxImportSize (Integer) —

    . optional

  • payload.paying (Boolean) —

    . optional

  • payload.enableMemoriCreation (Boolean) —

    . optional

  • payload.enableBoardOfExperts (Boolean) —

    . optional

  • payload.enableDCMIntegration (Boolean) —

    . optional

  • payload.enableBadges (Boolean) —

    . optional

  • payload.enableDeepThought (Boolean) —

    . optional

  • payload.enableVirtualSpaces (Boolean) —

    . optional

  • payload.birthDate (String) —

    . optional

  • payload.age (Integer) —

    . optional

  • payload.tnCAndPPAccepted (Boolean) —

    . optional

  • payload.tnCAndPPAcceptanceDate (String) —

    . optional

  • payload.pAndCUAccepted (Boolean) —

    . optional

  • payload.pAndCUAcceptanceDate (String) —

    . optional

  • payload.verificationCode (String) —

    . optional

  • payload.flowID (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional



1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/memori_client/backend/v2/user.rb', line 1311

def self.confirm_password_reset(payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'admin',
    'age',
    'avatar3DURL',
    'avatar3DURLType',
    'avatarURL',
    'birthDate',
    'couponCode',
    'creationTimestamp',
    'dontSendInvitationEmail',
    'eMail',
    'enableBadges',
    'enableBoardOfExperts',
    'enableDCMIntegration',
    'enableDeepThought',
    'enableMemoriCreation',
    'enableVirtualSpaces',
    'flowID',
    'lastChangeTimestamp',
    'maxCompletions',
    'maxFreeSessions',
    'maxImportSize',
    'maxMemori',
    'monthCompletions',
    'monthDeepThoughtCompletions',
    'monthDeepThoughtValidSessions',
    'monthImportedSize',
    'monthSessions',
    'monthValidSessions',
    'newPassword',
    'newsletterSubscribed',
    'nonFreeSessionCost',
    'notificationPrefs',
    'numMemori',
    'pAndCUAcceptanceDate',
    'pAndCUAccepted',
    'password',
    'paying',
    'referral',
    'superAdmin',
    'tenant',
    'tnCAndPPAcceptanceDate',
    'tnCAndPPAccepted',
    'userID',
    'userName',
    'verificationCode',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ResetConfirm', **args)
end

.confirm_registration(payload: {}) ⇒ Object

‘POST /api/v2/UserConfirm`

Confirms the registration of a User and performs a Login.

‘confirm_registration(payload: {})`

Parameters:

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.tenant (String) —

    . optional

  • payload.userID (String) —

    . optional

  • payload.userName (String) —

    . optional

  • payload.password (String) —

    . optional

  • payload.newPassword (String) —

    . optional

  • payload.eMail (String) —

    . optional

  • payload.avatarURL (String) —

    . optional

  • payload.avatar3DURL (String) —

    . optional

  • payload.avatar3DURLType (String) —

    . optional

  • payload.dontSendInvitationEmail (Boolean) —

    . optional

  • payload.referral (String) —

    . optional

  • payload.couponCode (String) —

    . optional

  • payload.newsletterSubscribed (Boolean) —

    . optional

  • payload.notificationPrefs (Array) —

    . optional

  • payload.admin (Boolean) —

    . optional

  • payload.superAdmin (Boolean) —

    . optional

  • payload.numMemori (Integer) —

    . optional

  • payload.maxMemori (Integer) —

    . optional

  • payload.monthSessions (Integer) —

    . optional

  • payload.monthValidSessions (Integer) —

    . optional

  • payload.monthDeepThoughtValidSessions (Integer) —

    . optional

  • payload.maxFreeSessions (Integer) —

    . optional

  • payload.nonFreeSessionCost (Number) —

    . optional

  • payload.monthCompletions (Integer) —

    . optional

  • payload.monthDeepThoughtCompletions (Integer) —

    . optional

  • payload.monthImportedSize (Integer) —

    . optional

  • payload.maxCompletions (Integer) —

    . optional

  • payload.maxImportSize (Integer) —

    . optional

  • payload.paying (Boolean) —

    . optional

  • payload.enableMemoriCreation (Boolean) —

    . optional

  • payload.enableBoardOfExperts (Boolean) —

    . optional

  • payload.enableDCMIntegration (Boolean) —

    . optional

  • payload.enableBadges (Boolean) —

    . optional

  • payload.enableDeepThought (Boolean) —

    . optional

  • payload.enableVirtualSpaces (Boolean) —

    . optional

  • payload.birthDate (String) —

    . optional

  • payload.age (Integer) —

    . optional

  • payload.tnCAndPPAccepted (Boolean) —

    . optional

  • payload.tnCAndPPAcceptanceDate (String) —

    . optional

  • payload.pAndCUAccepted (Boolean) —

    . optional

  • payload.pAndCUAcceptanceDate (String) —

    . optional

  • payload.verificationCode (String) —

    . optional

  • payload.flowID (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/memori_client/backend/v2/user.rb', line 1005

def self.confirm_registration(payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'admin',
    'age',
    'avatar3DURL',
    'avatar3DURLType',
    'avatarURL',
    'birthDate',
    'couponCode',
    'creationTimestamp',
    'dontSendInvitationEmail',
    'eMail',
    'enableBadges',
    'enableBoardOfExperts',
    'enableDCMIntegration',
    'enableDeepThought',
    'enableMemoriCreation',
    'enableVirtualSpaces',
    'flowID',
    'lastChangeTimestamp',
    'maxCompletions',
    'maxFreeSessions',
    'maxImportSize',
    'maxMemori',
    'monthCompletions',
    'monthDeepThoughtCompletions',
    'monthDeepThoughtValidSessions',
    'monthImportedSize',
    'monthSessions',
    'monthValidSessions',
    'newPassword',
    'newsletterSubscribed',
    'nonFreeSessionCost',
    'notificationPrefs',
    'numMemori',
    'pAndCUAcceptanceDate',
    'pAndCUAccepted',
    'password',
    'paying',
    'referral',
    'superAdmin',
    'tenant',
    'tnCAndPPAcceptanceDate',
    'tnCAndPPAccepted',
    'userID',
    'userName',
    'verificationCode',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/UserConfirm', **args)
end

.create_user(strToken:, payload: {}) ⇒ Object

‘POST /api/v2/User/strToken`

Creates a new user.

‘create_user(strToken:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.tenant (String) —

    . optional

  • payload.userID (String) —

    . optional

  • payload.userName (String) —

    . optional

  • payload.password (String) —

    . optional

  • payload.newPassword (String) —

    . optional

  • payload.eMail (String) —

    . optional

  • payload.avatarURL (String) —

    . optional

  • payload.avatar3DURL (String) —

    . optional

  • payload.avatar3DURLType (String) —

    . optional

  • payload.dontSendInvitationEmail (Boolean) —

    . optional

  • payload.referral (String) —

    . optional

  • payload.couponCode (String) —

    . optional

  • payload.newsletterSubscribed (Boolean) —

    . optional

  • payload.notificationPrefs (Array) —

    . optional

  • payload.admin (Boolean) —

    . optional

  • payload.superAdmin (Boolean) —

    . optional

  • payload.numMemori (Integer) —

    . optional

  • payload.maxMemori (Integer) —

    . optional

  • payload.monthSessions (Integer) —

    . optional

  • payload.monthValidSessions (Integer) —

    . optional

  • payload.monthDeepThoughtValidSessions (Integer) —

    . optional

  • payload.maxFreeSessions (Integer) —

    . optional

  • payload.nonFreeSessionCost (Number) —

    . optional

  • payload.monthCompletions (Integer) —

    . optional

  • payload.monthDeepThoughtCompletions (Integer) —

    . optional

  • payload.monthImportedSize (Integer) —

    . optional

  • payload.maxCompletions (Integer) —

    . optional

  • payload.maxImportSize (Integer) —

    . optional

  • payload.paying (Boolean) —

    . optional

  • payload.enableMemoriCreation (Boolean) —

    . optional

  • payload.enableBoardOfExperts (Boolean) —

    . optional

  • payload.enableDCMIntegration (Boolean) —

    . optional

  • payload.enableBadges (Boolean) —

    . optional

  • payload.enableDeepThought (Boolean) —

    . optional

  • payload.enableVirtualSpaces (Boolean) —

    . optional

  • payload.birthDate (String) —

    . optional

  • payload.age (Integer) —

    . optional

  • payload.tnCAndPPAccepted (Boolean) —

    . optional

  • payload.tnCAndPPAcceptanceDate (String) —

    . optional

  • payload.pAndCUAccepted (Boolean) —

    . optional

  • payload.pAndCUAcceptanceDate (String) —

    . optional

  • payload.verificationCode (String) —

    . optional

  • payload.flowID (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/memori_client/backend/v2/user.rb', line 284

def self.create_user(strToken:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'admin',
    'age',
    'avatar3DURL',
    'avatar3DURLType',
    'avatarURL',
    'birthDate',
    'couponCode',
    'creationTimestamp',
    'dontSendInvitationEmail',
    'eMail',
    'enableBadges',
    'enableBoardOfExperts',
    'enableDCMIntegration',
    'enableDeepThought',
    'enableMemoriCreation',
    'enableVirtualSpaces',
    'flowID',
    'lastChangeTimestamp',
    'maxCompletions',
    'maxFreeSessions',
    'maxImportSize',
    'maxMemori',
    'monthCompletions',
    'monthDeepThoughtCompletions',
    'monthDeepThoughtValidSessions',
    'monthImportedSize',
    'monthSessions',
    'monthValidSessions',
    'newPassword',
    'newsletterSubscribed',
    'nonFreeSessionCost',
    'notificationPrefs',
    'numMemori',
    'pAndCUAcceptanceDate',
    'pAndCUAccepted',
    'password',
    'paying',
    'referral',
    'superAdmin',
    'tenant',
    'tnCAndPPAcceptanceDate',
    'tnCAndPPAccepted',
    'userID',
    'userName',
    'verificationCode',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/User/{strToken}', **args)
end

.delete_user(strToken:, strUserID:) ⇒ Object

‘DELETE /api/v2/User/strToken/strUserID`

Deletes a User object.

‘delete_user(strToken:, strUserID:)`

Parameters:

  • strToken (string) —

    The login token. required

  • strUserID (string) —

    The User object ID. required



522
523
524
525
526
 
# File 'lib/memori_client/backend/v2/user.rb', line 522

def self.delete_user(strToken:, strUserID:)
  args = build_arguments(binding)

  exec_http_request('delete', '/api/v2/User/{strToken}/{strUserID}', **args)
end

.filter_users(strToken:, payload: {}) ⇒ Object

‘POST /api/v2/FilterUsers/strToken`

Returns a paginated list of User objects filtered by the specified criteria

‘filter_users(strToken:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.periodFrom (String) —

    . optional

  • payload.periodTo (String) —

    . optional

  • payload.tenantName (String) —

    . optional

  • payload.text (String) —

    . optional

  • payload.numberOfResults (Integer) —

    . optional

  • payload.startFrom (Integer) —

    . optional

  • payload.orderBy (String) —

    . optional



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/memori_client/backend/v2/user.rb', line 584

def self.filter_users(strToken:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'numberOfResults',
    'orderBy',
    'periodFrom',
    'periodTo',
    'startFrom',
    'tenantName',
    'text',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/FilterUsers/{strToken}', **args)
end

.get_user(strToken:) ⇒ Object

‘GET /api/v2/User/strToken`

Gets the details of the currently logged in User object.

‘get_user(strToken:)`

Parameters:

  • strToken (string) —

    The login token. required



178
179
180
181
182
 
# File 'lib/memori_client/backend/v2/user.rb', line 178

def self.get_user(strToken:)
  args = build_arguments(binding)

  exec_http_request('get', '/api/v2/User/{strToken}', **args)
end

.get_user_by_id(strToken:, strUserID:) ⇒ Object

‘GET /api/v2/User/strToken/strUserID`

Gets the details of a User object.

‘get_user_by_id(strToken:, strUserID:)`

Parameters:

  • strToken (string) —

    The login token. required

  • strUserID (string) —

    The User object ID. required



349
350
351
352
353
 
# File 'lib/memori_client/backend/v2/user.rb', line 349

def self.get_user_by_id(strToken:, strUserID:)
  args = build_arguments(binding)

  exec_http_request('get', '/api/v2/User/{strToken}/{strUserID}', **args)
end

.list_users(strToken:) ⇒ Object

‘GET /api/v2/Users/strToken`

Gets a list of all the existing User objects.

‘list_users(strToken:)`

Parameters:

  • strToken (string) —

    The login token. required



536
537
538
539
540
 
# File 'lib/memori_client/backend/v2/user.rb', line 536

def self.list_users(strToken:)
  args = build_arguments(binding)

  exec_http_request('get', '/api/v2/Users/{strToken}', **args)
end

.list_users_paginated(strToken:, from:, howMany:) ⇒ Object

‘GET /api/v2/Users/strToken/from/howMany`

Gets a paginated list of the existing User objects.

‘list_users_paginated(strToken:, from:, howMany:)`

Parameters:

  • strToken (string) —

    The login token. required

  • from (integer) —

    The index of the starting user to get. required

  • howMany (integer) —

    How many users to get. required



554
555
556
557
558
 
# File 'lib/memori_client/backend/v2/user.rb', line 554

def self.list_users_paginated(strToken:, from:, howMany:)
  args = build_arguments(binding)

  exec_http_request('get', '/api/v2/Users/{strToken}/{from}/{howMany}', **args)
end

.login(payload: {}) ⇒ Object

‘POST /api/v2/Login`

Tries a login with the specified credentials and returns a login token if successful.

‘login(payload: {})`

Parameters:

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.tenant (String) —

    . optional

  • payload.userID (String) —

    . optional

  • payload.userName (String) —

    . optional

  • payload.password (String) —

    . optional

  • payload.newPassword (String) —

    . optional

  • payload.eMail (String) —

    . optional

  • payload.avatarURL (String) —

    . optional

  • payload.avatar3DURL (String) —

    . optional

  • payload.avatar3DURLType (String) —

    . optional

  • payload.dontSendInvitationEmail (Boolean) —

    . optional

  • payload.referral (String) —

    . optional

  • payload.couponCode (String) —

    . optional

  • payload.newsletterSubscribed (Boolean) —

    . optional

  • payload.notificationPrefs (Array) —

    . optional

  • payload.admin (Boolean) —

    . optional

  • payload.superAdmin (Boolean) —

    . optional

  • payload.numMemori (Integer) —

    . optional

  • payload.maxMemori (Integer) —

    . optional

  • payload.monthSessions (Integer) —

    . optional

  • payload.monthValidSessions (Integer) —

    . optional

  • payload.monthDeepThoughtValidSessions (Integer) —

    . optional

  • payload.maxFreeSessions (Integer) —

    . optional

  • payload.nonFreeSessionCost (Number) —

    . optional

  • payload.monthCompletions (Integer) —

    . optional

  • payload.monthDeepThoughtCompletions (Integer) —

    . optional

  • payload.monthImportedSize (Integer) —

    . optional

  • payload.maxCompletions (Integer) —

    . optional

  • payload.maxImportSize (Integer) —

    . optional

  • payload.paying (Boolean) —

    . optional

  • payload.enableMemoriCreation (Boolean) —

    . optional

  • payload.enableBoardOfExperts (Boolean) —

    . optional

  • payload.enableDCMIntegration (Boolean) —

    . optional

  • payload.enableBadges (Boolean) —

    . optional

  • payload.enableDeepThought (Boolean) —

    . optional

  • payload.enableVirtualSpaces (Boolean) —

    . optional

  • payload.birthDate (String) —

    . optional

  • payload.age (Integer) —

    . optional

  • payload.tnCAndPPAccepted (Boolean) —

    . optional

  • payload.tnCAndPPAcceptanceDate (String) —

    . optional

  • payload.pAndCUAccepted (Boolean) —

    . optional

  • payload.pAndCUAcceptanceDate (String) —

    . optional

  • payload.verificationCode (String) —

    . optional

  • payload.flowID (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/memori_client/backend/v2/user.rb', line 101

def self.(payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'admin',
    'age',
    'avatar3DURL',
    'avatar3DURLType',
    'avatarURL',
    'birthDate',
    'couponCode',
    'creationTimestamp',
    'dontSendInvitationEmail',
    'eMail',
    'enableBadges',
    'enableBoardOfExperts',
    'enableDCMIntegration',
    'enableDeepThought',
    'enableMemoriCreation',
    'enableVirtualSpaces',
    'flowID',
    'lastChangeTimestamp',
    'maxCompletions',
    'maxFreeSessions',
    'maxImportSize',
    'maxMemori',
    'monthCompletions',
    'monthDeepThoughtCompletions',
    'monthDeepThoughtValidSessions',
    'monthImportedSize',
    'monthSessions',
    'monthValidSessions',
    'newPassword',
    'newsletterSubscribed',
    'nonFreeSessionCost',
    'notificationPrefs',
    'numMemori',
    'pAndCUAcceptanceDate',
    'pAndCUAccepted',
    'password',
    'paying',
    'referral',
    'superAdmin',
    'tenant',
    'tnCAndPPAcceptanceDate',
    'tnCAndPPAccepted',
    'userID',
    'userName',
    'verificationCode',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/Login', **args)
end

.logout(strToken:) ⇒ Object

‘POST /api/v2/Logout/strToken`

Logs out the User.

‘logout(strToken:)`

Parameters:

  • strToken (string) —

    The login token. required



164
165
166
167
168
 
# File 'lib/memori_client/backend/v2/user.rb', line 164

def self.logout(strToken:)
  args = build_arguments(binding)

  exec_http_request('post', '/api/v2/Logout/{strToken}', **args)
end

.recover_user_name(payload: {}) ⇒ Object

‘POST /api/v2/RecoverUserName`

Recovers a User’s name and sends it to their configured e-mail.

‘recover_user_name(payload: {})`

Parameters:

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.tenant (String) —

    . optional

  • payload.userID (String) —

    . optional

  • payload.userName (String) —

    . optional

  • payload.password (String) —

    . optional

  • payload.newPassword (String) —

    . optional

  • payload.eMail (String) —

    . optional

  • payload.avatarURL (String) —

    . optional

  • payload.avatar3DURL (String) —

    . optional

  • payload.avatar3DURLType (String) —

    . optional

  • payload.dontSendInvitationEmail (Boolean) —

    . optional

  • payload.referral (String) —

    . optional

  • payload.couponCode (String) —

    . optional

  • payload.newsletterSubscribed (Boolean) —

    . optional

  • payload.notificationPrefs (Array) —

    . optional

  • payload.admin (Boolean) —

    . optional

  • payload.superAdmin (Boolean) —

    . optional

  • payload.numMemori (Integer) —

    . optional

  • payload.maxMemori (Integer) —

    . optional

  • payload.monthSessions (Integer) —

    . optional

  • payload.monthValidSessions (Integer) —

    . optional

  • payload.monthDeepThoughtValidSessions (Integer) —

    . optional

  • payload.maxFreeSessions (Integer) —

    . optional

  • payload.nonFreeSessionCost (Number) —

    . optional

  • payload.monthCompletions (Integer) —

    . optional

  • payload.monthDeepThoughtCompletions (Integer) —

    . optional

  • payload.monthImportedSize (Integer) —

    . optional

  • payload.maxCompletions (Integer) —

    . optional

  • payload.maxImportSize (Integer) —

    . optional

  • payload.paying (Boolean) —

    . optional

  • payload.enableMemoriCreation (Boolean) —

    . optional

  • payload.enableBoardOfExperts (Boolean) —

    . optional

  • payload.enableDCMIntegration (Boolean) —

    . optional

  • payload.enableBadges (Boolean) —

    . optional

  • payload.enableDeepThought (Boolean) —

    . optional

  • payload.enableVirtualSpaces (Boolean) —

    . optional

  • payload.birthDate (String) —

    . optional

  • payload.age (Integer) —

    . optional

  • payload.tnCAndPPAccepted (Boolean) —

    . optional

  • payload.tnCAndPPAcceptanceDate (String) —

    . optional

  • payload.pAndCUAccepted (Boolean) —

    . optional

  • payload.pAndCUAcceptanceDate (String) —

    . optional

  • payload.verificationCode (String) —

    . optional

  • payload.flowID (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
 
# File 'lib/memori_client/backend/v2/user.rb', line 1464

def self.recover_user_name(payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'admin',
    'age',
    'avatar3DURL',
    'avatar3DURLType',
    'avatarURL',
    'birthDate',
    'couponCode',
    'creationTimestamp',
    'dontSendInvitationEmail',
    'eMail',
    'enableBadges',
    'enableBoardOfExperts',
    'enableDCMIntegration',
    'enableDeepThought',
    'enableMemoriCreation',
    'enableVirtualSpaces',
    'flowID',
    'lastChangeTimestamp',
    'maxCompletions',
    'maxFreeSessions',
    'maxImportSize',
    'maxMemori',
    'monthCompletions',
    'monthDeepThoughtCompletions',
    'monthDeepThoughtValidSessions',
    'monthImportedSize',
    'monthSessions',
    'monthValidSessions',
    'newPassword',
    'newsletterSubscribed',
    'nonFreeSessionCost',
    'notificationPrefs',
    'numMemori',
    'pAndCUAcceptanceDate',
    'pAndCUAccepted',
    'password',
    'paying',
    'referral',
    'superAdmin',
    'tenant',
    'tnCAndPPAcceptanceDate',
    'tnCAndPPAccepted',
    'userID',
    'userName',
    'verificationCode',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/RecoverUserName', **args)
end

.register_user(payload: {}) ⇒ Object

‘POST /api/v2/User`

Registers a new user.

‘register_user(payload: {})`

Parameters:

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.tenant (String) —

    . optional

  • payload.userID (String) —

    . optional

  • payload.userName (String) —

    . optional

  • payload.password (String) —

    . optional

  • payload.newPassword (String) —

    . optional

  • payload.eMail (String) —

    . optional

  • payload.avatarURL (String) —

    . optional

  • payload.avatar3DURL (String) —

    . optional

  • payload.avatar3DURLType (String) —

    . optional

  • payload.dontSendInvitationEmail (Boolean) —

    . optional

  • payload.referral (String) —

    . optional

  • payload.couponCode (String) —

    . optional

  • payload.newsletterSubscribed (Boolean) —

    . optional

  • payload.notificationPrefs (Array) —

    . optional

  • payload.admin (Boolean) —

    . optional

  • payload.superAdmin (Boolean) —

    . optional

  • payload.numMemori (Integer) —

    . optional

  • payload.maxMemori (Integer) —

    . optional

  • payload.monthSessions (Integer) —

    . optional

  • payload.monthValidSessions (Integer) —

    . optional

  • payload.monthDeepThoughtValidSessions (Integer) —

    . optional

  • payload.maxFreeSessions (Integer) —

    . optional

  • payload.nonFreeSessionCost (Number) —

    . optional

  • payload.monthCompletions (Integer) —

    . optional

  • payload.monthDeepThoughtCompletions (Integer) —

    . optional

  • payload.monthImportedSize (Integer) —

    . optional

  • payload.maxCompletions (Integer) —

    . optional

  • payload.maxImportSize (Integer) —

    . optional

  • payload.paying (Boolean) —

    . optional

  • payload.enableMemoriCreation (Boolean) —

    . optional

  • payload.enableBoardOfExperts (Boolean) —

    . optional

  • payload.enableDCMIntegration (Boolean) —

    . optional

  • payload.enableBadges (Boolean) —

    . optional

  • payload.enableDeepThought (Boolean) —

    . optional

  • payload.enableVirtualSpaces (Boolean) —

    . optional

  • payload.birthDate (String) —

    . optional

  • payload.age (Integer) —

    . optional

  • payload.tnCAndPPAccepted (Boolean) —

    . optional

  • payload.tnCAndPPAcceptanceDate (String) —

    . optional

  • payload.pAndCUAccepted (Boolean) —

    . optional

  • payload.pAndCUAcceptanceDate (String) —

    . optional

  • payload.verificationCode (String) —

    . optional

  • payload.flowID (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/memori_client/backend/v2/user.rb', line 699

def self.register_user(payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'admin',
    'age',
    'avatar3DURL',
    'avatar3DURLType',
    'avatarURL',
    'birthDate',
    'couponCode',
    'creationTimestamp',
    'dontSendInvitationEmail',
    'eMail',
    'enableBadges',
    'enableBoardOfExperts',
    'enableDCMIntegration',
    'enableDeepThought',
    'enableMemoriCreation',
    'enableVirtualSpaces',
    'flowID',
    'lastChangeTimestamp',
    'maxCompletions',
    'maxFreeSessions',
    'maxImportSize',
    'maxMemori',
    'monthCompletions',
    'monthDeepThoughtCompletions',
    'monthDeepThoughtValidSessions',
    'monthImportedSize',
    'monthSessions',
    'monthValidSessions',
    'newPassword',
    'newsletterSubscribed',
    'nonFreeSessionCost',
    'notificationPrefs',
    'numMemori',
    'pAndCUAcceptanceDate',
    'pAndCUAccepted',
    'password',
    'paying',
    'referral',
    'superAdmin',
    'tenant',
    'tnCAndPPAcceptanceDate',
    'tnCAndPPAccepted',
    'userID',
    'userName',
    'verificationCode',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/User', **args)
end

.resend_verification_code(payload: {}) ⇒ Object

‘POST /api/v2/ResendVerificationCode`

Re-sends the verification code to confirm a pending User registration.

‘resend_verification_code(payload: {})`

Parameters:

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.tenant (String) —

    . optional

  • payload.userID (String) —

    . optional

  • payload.userName (String) —

    . optional

  • payload.password (String) —

    . optional

  • payload.newPassword (String) —

    . optional

  • payload.eMail (String) —

    . optional

  • payload.avatarURL (String) —

    . optional

  • payload.avatar3DURL (String) —

    . optional

  • payload.avatar3DURLType (String) —

    . optional

  • payload.dontSendInvitationEmail (Boolean) —

    . optional

  • payload.referral (String) —

    . optional

  • payload.couponCode (String) —

    . optional

  • payload.newsletterSubscribed (Boolean) —

    . optional

  • payload.notificationPrefs (Array) —

    . optional

  • payload.admin (Boolean) —

    . optional

  • payload.superAdmin (Boolean) —

    . optional

  • payload.numMemori (Integer) —

    . optional

  • payload.maxMemori (Integer) —

    . optional

  • payload.monthSessions (Integer) —

    . optional

  • payload.monthValidSessions (Integer) —

    . optional

  • payload.monthDeepThoughtValidSessions (Integer) —

    . optional

  • payload.maxFreeSessions (Integer) —

    . optional

  • payload.nonFreeSessionCost (Number) —

    . optional

  • payload.monthCompletions (Integer) —

    . optional

  • payload.monthDeepThoughtCompletions (Integer) —

    . optional

  • payload.monthImportedSize (Integer) —

    . optional

  • payload.maxCompletions (Integer) —

    . optional

  • payload.maxImportSize (Integer) —

    . optional

  • payload.paying (Boolean) —

    . optional

  • payload.enableMemoriCreation (Boolean) —

    . optional

  • payload.enableBoardOfExperts (Boolean) —

    . optional

  • payload.enableDCMIntegration (Boolean) —

    . optional

  • payload.enableBadges (Boolean) —

    . optional

  • payload.enableDeepThought (Boolean) —

    . optional

  • payload.enableVirtualSpaces (Boolean) —

    . optional

  • payload.birthDate (String) —

    . optional

  • payload.age (Integer) —

    . optional

  • payload.tnCAndPPAccepted (Boolean) —

    . optional

  • payload.tnCAndPPAcceptanceDate (String) —

    . optional

  • payload.pAndCUAccepted (Boolean) —

    . optional

  • payload.pAndCUAcceptanceDate (String) —

    . optional

  • payload.verificationCode (String) —

    . optional

  • payload.flowID (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional



852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/memori_client/backend/v2/user.rb', line 852

def self.resend_verification_code(payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'admin',
    'age',
    'avatar3DURL',
    'avatar3DURLType',
    'avatarURL',
    'birthDate',
    'couponCode',
    'creationTimestamp',
    'dontSendInvitationEmail',
    'eMail',
    'enableBadges',
    'enableBoardOfExperts',
    'enableDCMIntegration',
    'enableDeepThought',
    'enableMemoriCreation',
    'enableVirtualSpaces',
    'flowID',
    'lastChangeTimestamp',
    'maxCompletions',
    'maxFreeSessions',
    'maxImportSize',
    'maxMemori',
    'monthCompletions',
    'monthDeepThoughtCompletions',
    'monthDeepThoughtValidSessions',
    'monthImportedSize',
    'monthSessions',
    'monthValidSessions',
    'newPassword',
    'newsletterSubscribed',
    'nonFreeSessionCost',
    'notificationPrefs',
    'numMemori',
    'pAndCUAcceptanceDate',
    'pAndCUAccepted',
    'password',
    'paying',
    'referral',
    'superAdmin',
    'tenant',
    'tnCAndPPAcceptanceDate',
    'tnCAndPPAccepted',
    'userID',
    'userName',
    'verificationCode',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ResendVerificationCode', **args)
end

.reset_user_password(payload: {}) ⇒ Object

‘POST /api/v2/ResetPassword`

Resets a User’s password.

‘reset_user_password(payload: {})`

Parameters:

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.tenant (String) —

    . optional

  • payload.userID (String) —

    . optional

  • payload.userName (String) —

    . optional

  • payload.password (String) —

    . optional

  • payload.newPassword (String) —

    . optional

  • payload.eMail (String) —

    . optional

  • payload.avatarURL (String) —

    . optional

  • payload.avatar3DURL (String) —

    . optional

  • payload.avatar3DURLType (String) —

    . optional

  • payload.dontSendInvitationEmail (Boolean) —

    . optional

  • payload.referral (String) —

    . optional

  • payload.couponCode (String) —

    . optional

  • payload.newsletterSubscribed (Boolean) —

    . optional

  • payload.notificationPrefs (Array) —

    . optional

  • payload.admin (Boolean) —

    . optional

  • payload.superAdmin (Boolean) —

    . optional

  • payload.numMemori (Integer) —

    . optional

  • payload.maxMemori (Integer) —

    . optional

  • payload.monthSessions (Integer) —

    . optional

  • payload.monthValidSessions (Integer) —

    . optional

  • payload.monthDeepThoughtValidSessions (Integer) —

    . optional

  • payload.maxFreeSessions (Integer) —

    . optional

  • payload.nonFreeSessionCost (Number) —

    . optional

  • payload.monthCompletions (Integer) —

    . optional

  • payload.monthDeepThoughtCompletions (Integer) —

    . optional

  • payload.monthImportedSize (Integer) —

    . optional

  • payload.maxCompletions (Integer) —

    . optional

  • payload.maxImportSize (Integer) —

    . optional

  • payload.paying (Boolean) —

    . optional

  • payload.enableMemoriCreation (Boolean) —

    . optional

  • payload.enableBoardOfExperts (Boolean) —

    . optional

  • payload.enableDCMIntegration (Boolean) —

    . optional

  • payload.enableBadges (Boolean) —

    . optional

  • payload.enableDeepThought (Boolean) —

    . optional

  • payload.enableVirtualSpaces (Boolean) —

    . optional

  • payload.birthDate (String) —

    . optional

  • payload.age (Integer) —

    . optional

  • payload.tnCAndPPAccepted (Boolean) —

    . optional

  • payload.tnCAndPPAcceptanceDate (String) —

    . optional

  • payload.pAndCUAccepted (Boolean) —

    . optional

  • payload.pAndCUAcceptanceDate (String) —

    . optional

  • payload.verificationCode (String) —

    . optional

  • payload.flowID (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
 
# File 'lib/memori_client/backend/v2/user.rb', line 1158

def self.reset_user_password(payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'admin',
    'age',
    'avatar3DURL',
    'avatar3DURLType',
    'avatarURL',
    'birthDate',
    'couponCode',
    'creationTimestamp',
    'dontSendInvitationEmail',
    'eMail',
    'enableBadges',
    'enableBoardOfExperts',
    'enableDCMIntegration',
    'enableDeepThought',
    'enableMemoriCreation',
    'enableVirtualSpaces',
    'flowID',
    'lastChangeTimestamp',
    'maxCompletions',
    'maxFreeSessions',
    'maxImportSize',
    'maxMemori',
    'monthCompletions',
    'monthDeepThoughtCompletions',
    'monthDeepThoughtValidSessions',
    'monthImportedSize',
    'monthSessions',
    'monthValidSessions',
    'newPassword',
    'newsletterSubscribed',
    'nonFreeSessionCost',
    'notificationPrefs',
    'numMemori',
    'pAndCUAcceptanceDate',
    'pAndCUAccepted',
    'password',
    'paying',
    'referral',
    'superAdmin',
    'tenant',
    'tnCAndPPAcceptanceDate',
    'tnCAndPPAccepted',
    'userID',
    'userName',
    'verificationCode',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ResetPassword', **args)
end

.update_user(strToken:, strUserID:, payload: {}) ⇒ Object

‘PATCH /api/v2/User/strToken/strUserID`

Updates the details of a User object (including its password).

‘update_user(strToken:, strUserID:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • strUserID (string) —

    The User object ID. required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.tenant (String) —

    . optional

  • payload.userID (String) —

    . optional

  • payload.userName (String) —

    . optional

  • payload.password (String) —

    . optional

  • payload.newPassword (String) —

    . optional

  • payload.eMail (String) —

    . optional

  • payload.avatarURL (String) —

    . optional

  • payload.avatar3DURL (String) —

    . optional

  • payload.avatar3DURLType (String) —

    . optional

  • payload.dontSendInvitationEmail (Boolean) —

    . optional

  • payload.referral (String) —

    . optional

  • payload.couponCode (String) —

    . optional

  • payload.newsletterSubscribed (Boolean) —

    . optional

  • payload.notificationPrefs (Array) —

    . optional

  • payload.admin (Boolean) —

    . optional

  • payload.superAdmin (Boolean) —

    . optional

  • payload.numMemori (Integer) —

    . optional

  • payload.maxMemori (Integer) —

    . optional

  • payload.monthSessions (Integer) —

    . optional

  • payload.monthValidSessions (Integer) —

    . optional

  • payload.monthDeepThoughtValidSessions (Integer) —

    . optional

  • payload.maxFreeSessions (Integer) —

    . optional

  • payload.nonFreeSessionCost (Number) —

    . optional

  • payload.monthCompletions (Integer) —

    . optional

  • payload.monthDeepThoughtCompletions (Integer) —

    . optional

  • payload.monthImportedSize (Integer) —

    . optional

  • payload.maxCompletions (Integer) —

    . optional

  • payload.maxImportSize (Integer) —

    . optional

  • payload.paying (Boolean) —

    . optional

  • payload.enableMemoriCreation (Boolean) —

    . optional

  • payload.enableBoardOfExperts (Boolean) —

    . optional

  • payload.enableDCMIntegration (Boolean) —

    . optional

  • payload.enableBadges (Boolean) —

    . optional

  • payload.enableDeepThought (Boolean) —

    . optional

  • payload.enableVirtualSpaces (Boolean) —

    . optional

  • payload.birthDate (String) —

    . optional

  • payload.age (Integer) —

    . optional

  • payload.tnCAndPPAccepted (Boolean) —

    . optional

  • payload.tnCAndPPAcceptanceDate (String) —

    . optional

  • payload.pAndCUAccepted (Boolean) —

    . optional

  • payload.pAndCUAcceptanceDate (String) —

    . optional

  • payload.verificationCode (String) —

    . optional

  • payload.flowID (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/memori_client/backend/v2/user.rb', line 457

def self.update_user(strToken:, strUserID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'admin',
    'age',
    'avatar3DURL',
    'avatar3DURLType',
    'avatarURL',
    'birthDate',
    'couponCode',
    'creationTimestamp',
    'dontSendInvitationEmail',
    'eMail',
    'enableBadges',
    'enableBoardOfExperts',
    'enableDCMIntegration',
    'enableDeepThought',
    'enableMemoriCreation',
    'enableVirtualSpaces',
    'flowID',
    'lastChangeTimestamp',
    'maxCompletions',
    'maxFreeSessions',
    'maxImportSize',
    'maxMemori',
    'monthCompletions',
    'monthDeepThoughtCompletions',
    'monthDeepThoughtValidSessions',
    'monthImportedSize',
    'monthSessions',
    'monthValidSessions',
    'newPassword',
    'newsletterSubscribed',
    'nonFreeSessionCost',
    'notificationPrefs',
    'numMemori',
    'pAndCUAcceptanceDate',
    'pAndCUAccepted',
    'password',
    'paying',
    'referral',
    'superAdmin',
    'tenant',
    'tnCAndPPAcceptanceDate',
    'tnCAndPPAccepted',
    'userID',
    'userName',
    'verificationCode',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('patch', '/api/v2/User/{strToken}/{strUserID}', **args)
end