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