memori-client 0.1.6 → 0.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/doc/MemoriClient::Backend::V1::Asset.md +117 -0
- data/doc/MemoriClient::Backend::V2::ActionLog.md +37 -0
- data/doc/MemoriClient::Backend::V2::Analysis.md +39 -0
- data/doc/MemoriClient::Backend::V2::Asset.md +102 -0
- data/doc/MemoriClient::Backend::V2::Badge.md +64 -0
- data/doc/MemoriClient::Backend::V2::CompletionConfig.md +115 -0
- data/doc/MemoriClient::Backend::V2::ConsumptionLog.md +57 -0
- data/doc/MemoriClient::Backend::V2::ImportExport.md +180 -0
- data/doc/MemoriClient::Backend::V2::Integration.md +117 -0
- data/doc/MemoriClient::Backend::V2::Invitation.md +179 -0
- data/doc/MemoriClient::Backend::V2::Memori.md +394 -0
- data/doc/MemoriClient::Backend::V2::MemoriList.md +147 -0
- data/doc/MemoriClient::Backend::V2::Notification.md +31 -0
- data/doc/MemoriClient::Backend::V2::Process.md +64 -0
- data/doc/MemoriClient::Backend::V2::Tenant.md +142 -0
- data/doc/MemoriClient::Backend::V2::User.md +647 -0
- data/doc/MemoriClient::Engine::V2::ChatLog.md +82 -0
- data/doc/MemoriClient::Engine::V2::ContextVar.md +46 -0
- data/doc/MemoriClient::Engine::V2::CorrelationPair.md +72 -0
- data/doc/MemoriClient::Engine::V2::CustomDictionary.md +108 -0
- data/doc/MemoriClient::Engine::V2::Dialog.md +152 -0
- data/doc/MemoriClient::Engine::V2::EventLog.md +85 -0
- data/doc/MemoriClient::Engine::V2::ExpertReference.md +116 -0
- data/doc/MemoriClient::Engine::V2::Function.md +140 -0
- data/doc/MemoriClient::Engine::V2::Intent.md +225 -0
- data/doc/MemoriClient::Engine::V2::LocalizationKey.md +105 -0
- data/doc/MemoriClient::Engine::V2::Medium.md +118 -0
- data/doc/MemoriClient::Engine::V2::Memory.md +244 -0
- data/doc/MemoriClient::Engine::V2::NLP.md +100 -0
- data/doc/MemoriClient::Engine::V2::Person.md +114 -0
- data/doc/MemoriClient::Engine::V2::Search.md +151 -0
- data/doc/MemoriClient::Engine::V2::Session.md +55 -0
- data/doc/MemoriClient::Engine::V2::Stat.md +18 -0
- data/doc/MemoriClient::Engine::V2::Topic.md +80 -0
- data/doc/MemoriClient::Engine::V2::UnansweredQuestion.md +75 -0
- data/doc/MemoriClient::Engine::V2::User.md +140 -0
- data/doc/MemoriClient::Engine::V2::WebHook.md +67 -0
- data/lib/memori_client/railtie.rb +12 -0
- data/lib/memori_client/utils/rails.rb +54 -0
- data/lib/memori_client.rb +7 -0
- data/lib/tasks/memori_client.rake +15 -0
- metadata +42 -2
@@ -0,0 +1,140 @@
|
|
1
|
+
# Module `MemoriClient::Engine::V2::Function`
|
2
|
+
|
3
|
+
## list_macro_functions
|
4
|
+
|
5
|
+
Summary:
|
6
|
+
Lists all Macro Function objects.
|
7
|
+
|
8
|
+
Signature: `list_macro_functions(strSessionID:)`
|
9
|
+
Invocation: `MemoriClient::Engine::V2::Function.list_macro_functions(strSessionID:)`
|
10
|
+
|
11
|
+
HTTP API: GET /memori/v2/MacroFunctions/{strSessionID}`
|
12
|
+
|
13
|
+
Parameters:
|
14
|
+
|
15
|
+
- `strSessionID`: **string** The session ID. required
|
16
|
+
|
17
|
+
## list_functions
|
18
|
+
|
19
|
+
Summary:
|
20
|
+
Lists all Function objects.
|
21
|
+
|
22
|
+
Signature: `list_functions(strSessionID:)`
|
23
|
+
Invocation: `MemoriClient::Engine::V2::Function.list_functions(strSessionID:)`
|
24
|
+
|
25
|
+
HTTP API: GET /memori/v2/Functions/{strSessionID}`
|
26
|
+
|
27
|
+
Parameters:
|
28
|
+
|
29
|
+
- `strSessionID`: **string** The session ID. required
|
30
|
+
|
31
|
+
## list_functions_paginated
|
32
|
+
|
33
|
+
Summary:
|
34
|
+
Lists Function objects with pagination.
|
35
|
+
|
36
|
+
Signature: `list_functions_paginated(strSessionID:, from:, howMany:)`
|
37
|
+
Invocation: `MemoriClient::Engine::V2::Function.list_functions_paginated(strSessionID:, from:, howMany:)`
|
38
|
+
|
39
|
+
HTTP API: GET /memori/v2/Functions/{strSessionID}/{from}/{howMany}`
|
40
|
+
|
41
|
+
Parameters:
|
42
|
+
|
43
|
+
- `strSessionID`: **string** The session ID. required
|
44
|
+
- `from`: **integer** The 0-based index of the first Function object to list. required
|
45
|
+
- `howMany`: **integer** The number of the Function objects to list. required
|
46
|
+
|
47
|
+
## get_function
|
48
|
+
|
49
|
+
Summary:
|
50
|
+
Gets the details of a Function object.
|
51
|
+
|
52
|
+
Signature: `get_function(strSessionID:, strFunctionID:)`
|
53
|
+
Invocation: `MemoriClient::Engine::V2::Function.get_function(strSessionID:, strFunctionID:)`
|
54
|
+
|
55
|
+
HTTP API: GET /memori/v2/Function/{strSessionID}/{strFunctionID}`
|
56
|
+
|
57
|
+
Parameters:
|
58
|
+
|
59
|
+
- `strSessionID`: **string** The session ID. required
|
60
|
+
- `strFunctionID`: **string** The Function object ID. required
|
61
|
+
|
62
|
+
## update_function
|
63
|
+
|
64
|
+
Summary:
|
65
|
+
Updates an existing Function object.
|
66
|
+
|
67
|
+
Signature: `update_function(strSessionID:, strFunctionID:, payload: {})`
|
68
|
+
Invocation: `MemoriClient::Engine::V2::Function.update_function(strSessionID:, strFunctionID:, payload: {})`
|
69
|
+
|
70
|
+
HTTP API: PATCH /memori/v2/Function/{strSessionID}/{strFunctionID}`
|
71
|
+
|
72
|
+
Parameters:
|
73
|
+
|
74
|
+
- `strSessionID`: **string** The session ID. required
|
75
|
+
- `strFunctionID`: **string** The Function object ID. required
|
76
|
+
- `payload`: **Hash** request payload. optional
|
77
|
+
- `payload.functionID`: **String** . optional
|
78
|
+
- `payload.functionType`: **String** . optional
|
79
|
+
- `payload.name`: **String** . optional
|
80
|
+
- `payload.description`: **String** . optional
|
81
|
+
- `payload.parameters`: **Array** . optional
|
82
|
+
- `payload.webHook`: **String** . optional
|
83
|
+
- `payload.httpMethod`: **String** . optional
|
84
|
+
- `payload.httpHeaders`: **Object** . optional
|
85
|
+
- `payload.httpQueryStringTemplate`: **String** . optional
|
86
|
+
- `payload.httpBodyTemplate`: **String** . optional
|
87
|
+
- `payload.httpBodyContentType`: **String** . optional
|
88
|
+
- `payload.sendExtensionHeaders`: **Array** . optional
|
89
|
+
- `payload.creationTimestamp`: **String** . optional
|
90
|
+
- `payload.creationSessionID`: **String** . optional
|
91
|
+
- `payload.lastChangeTimestamp`: **String** . optional
|
92
|
+
- `payload.lastChangeSessionID`: **String** . optional
|
93
|
+
|
94
|
+
## remove_function
|
95
|
+
|
96
|
+
Summary:
|
97
|
+
Removes an existing Function object.
|
98
|
+
|
99
|
+
Signature: `remove_function(strSessionID:, strFunctionID:)`
|
100
|
+
Invocation: `MemoriClient::Engine::V2::Function.remove_function(strSessionID:, strFunctionID:)`
|
101
|
+
|
102
|
+
HTTP API: DELETE /memori/v2/Function/{strSessionID}/{strFunctionID}`
|
103
|
+
|
104
|
+
Parameters:
|
105
|
+
|
106
|
+
- `strSessionID`: **string** The session ID. required
|
107
|
+
- `strFunctionID`: **string** The Function object ID. required
|
108
|
+
|
109
|
+
## add_function
|
110
|
+
|
111
|
+
Summary:
|
112
|
+
Adds a new Function object.
|
113
|
+
|
114
|
+
Signature: `add_function(strSessionID:, payload: {})`
|
115
|
+
Invocation: `MemoriClient::Engine::V2::Function.add_function(strSessionID:, payload: {})`
|
116
|
+
|
117
|
+
HTTP API: POST /memori/v2/Function/{strSessionID}`
|
118
|
+
|
119
|
+
Parameters:
|
120
|
+
|
121
|
+
- `strSessionID`: **string** The session ID. required
|
122
|
+
- `payload`: **Hash** request payload. optional
|
123
|
+
- `payload.functionID`: **String** . optional
|
124
|
+
- `payload.functionType`: **String** . optional
|
125
|
+
- `payload.name`: **String** . optional
|
126
|
+
- `payload.description`: **String** . optional
|
127
|
+
- `payload.parameters`: **Array** . optional
|
128
|
+
- `payload.webHook`: **String** . optional
|
129
|
+
- `payload.httpMethod`: **String** . optional
|
130
|
+
- `payload.httpHeaders`: **Object** . optional
|
131
|
+
- `payload.httpQueryStringTemplate`: **String** . optional
|
132
|
+
- `payload.httpBodyTemplate`: **String** . optional
|
133
|
+
- `payload.httpBodyContentType`: **String** . optional
|
134
|
+
- `payload.sendExtensionHeaders`: **Array** . optional
|
135
|
+
- `payload.creationTimestamp`: **String** . optional
|
136
|
+
- `payload.creationSessionID`: **String** . optional
|
137
|
+
- `payload.lastChangeTimestamp`: **String** . optional
|
138
|
+
- `payload.lastChangeSessionID`: **String** . optional
|
139
|
+
|
140
|
+
|
@@ -0,0 +1,225 @@
|
|
1
|
+
# Module `MemoriClient::Engine::V2::Intent`
|
2
|
+
|
3
|
+
## list_intents
|
4
|
+
|
5
|
+
Summary:
|
6
|
+
Lists all Intent objects.
|
7
|
+
|
8
|
+
Signature: `list_intents(strSessionID:)`
|
9
|
+
Invocation: `MemoriClient::Engine::V2::Intent.list_intents(strSessionID:)`
|
10
|
+
|
11
|
+
HTTP API: GET /memori/v2/Intents/{strSessionID}`
|
12
|
+
|
13
|
+
Parameters:
|
14
|
+
|
15
|
+
- `strSessionID`: **string** The session ID. required
|
16
|
+
|
17
|
+
## list_intents_paginated
|
18
|
+
|
19
|
+
Summary:
|
20
|
+
Lists Intent objects with pagination.
|
21
|
+
|
22
|
+
Signature: `list_intents_paginated(strSessionID:, from:, howMany:)`
|
23
|
+
Invocation: `MemoriClient::Engine::V2::Intent.list_intents_paginated(strSessionID:, from:, howMany:)`
|
24
|
+
|
25
|
+
HTTP API: GET /memori/v2/Intents/{strSessionID}/{from}/{howMany}`
|
26
|
+
|
27
|
+
Parameters:
|
28
|
+
|
29
|
+
- `strSessionID`: **string** The session ID. required
|
30
|
+
- `from`: **integer** The 0-based index of the first Intent object to list. required
|
31
|
+
- `howMany`: **integer** The number of the Intent objects to list. required
|
32
|
+
|
33
|
+
## get_intent
|
34
|
+
|
35
|
+
Summary:
|
36
|
+
Gets the details of an Intent object.
|
37
|
+
|
38
|
+
Signature: `get_intent(strSessionID:, strIntentID:)`
|
39
|
+
Invocation: `MemoriClient::Engine::V2::Intent.get_intent(strSessionID:, strIntentID:)`
|
40
|
+
|
41
|
+
HTTP API: GET /memori/v2/Intent/{strSessionID}/{strIntentID}`
|
42
|
+
|
43
|
+
Parameters:
|
44
|
+
|
45
|
+
- `strSessionID`: **string** The session ID. required
|
46
|
+
- `strIntentID`: **string** The Intent object ID. required
|
47
|
+
|
48
|
+
## update_intent
|
49
|
+
|
50
|
+
Summary:
|
51
|
+
Updates an existing Intent object.
|
52
|
+
|
53
|
+
Signature: `update_intent(strSessionID:, strIntentID:, payload: {})`
|
54
|
+
Invocation: `MemoriClient::Engine::V2::Intent.update_intent(strSessionID:, strIntentID:, payload: {})`
|
55
|
+
|
56
|
+
HTTP API: PATCH /memori/v2/Intent/{strSessionID}/{strIntentID}`
|
57
|
+
|
58
|
+
Parameters:
|
59
|
+
|
60
|
+
- `strSessionID`: **string** The session ID. required
|
61
|
+
- `strIntentID`: **string** The Intent object ID. required
|
62
|
+
- `payload`: **Hash** request payload. optional
|
63
|
+
- `payload.intentID`: **String** . optional
|
64
|
+
- `payload.intentType`: **String** . optional
|
65
|
+
- `payload.name`: **String** . optional
|
66
|
+
- `payload.utterances`: **Array** . optional
|
67
|
+
- `payload.timeoutIntent`: **Boolean** . optional
|
68
|
+
- `payload.webHook`: **String** . optional
|
69
|
+
- `payload.validityMinutes`: **Number** . optional
|
70
|
+
- `payload.creationTimestamp`: **String** . optional
|
71
|
+
- `payload.creationSessionID`: **String** . optional
|
72
|
+
- `payload.lastChangeTimestamp`: **String** . optional
|
73
|
+
- `payload.lastChangeSessionID`: **String** . optional
|
74
|
+
|
75
|
+
## remove_intent
|
76
|
+
|
77
|
+
Summary:
|
78
|
+
Removes an existing Intent object.
|
79
|
+
|
80
|
+
Signature: `remove_intent(strSessionID:, strIntentID:)`
|
81
|
+
Invocation: `MemoriClient::Engine::V2::Intent.remove_intent(strSessionID:, strIntentID:)`
|
82
|
+
|
83
|
+
HTTP API: DELETE /memori/v2/Intent/{strSessionID}/{strIntentID}`
|
84
|
+
|
85
|
+
Parameters:
|
86
|
+
|
87
|
+
- `strSessionID`: **string** The session ID. required
|
88
|
+
- `strIntentID`: **string** The Intent object ID. required
|
89
|
+
|
90
|
+
## add_intent
|
91
|
+
|
92
|
+
Summary:
|
93
|
+
Adds a new Intent object.
|
94
|
+
|
95
|
+
Signature: `add_intent(strSessionID:, payload: {})`
|
96
|
+
Invocation: `MemoriClient::Engine::V2::Intent.add_intent(strSessionID:, payload: {})`
|
97
|
+
|
98
|
+
HTTP API: POST /memori/v2/Intent/{strSessionID}`
|
99
|
+
|
100
|
+
Parameters:
|
101
|
+
|
102
|
+
- `strSessionID`: **string** The session ID. required
|
103
|
+
- `payload`: **Hash** request payload. optional
|
104
|
+
- `payload.intentID`: **String** . optional
|
105
|
+
- `payload.intentType`: **String** . optional
|
106
|
+
- `payload.name`: **String** . optional
|
107
|
+
- `payload.utterances`: **Array** . optional
|
108
|
+
- `payload.timeoutIntent`: **Boolean** . optional
|
109
|
+
- `payload.webHook`: **String** . optional
|
110
|
+
- `payload.validityMinutes`: **Number** . optional
|
111
|
+
- `payload.creationTimestamp`: **String** . optional
|
112
|
+
- `payload.creationSessionID`: **String** . optional
|
113
|
+
- `payload.lastChangeTimestamp`: **String** . optional
|
114
|
+
- `payload.lastChangeSessionID`: **String** . optional
|
115
|
+
|
116
|
+
## list_intent_slots
|
117
|
+
|
118
|
+
Summary:
|
119
|
+
Lists all Intent Slot objects.
|
120
|
+
|
121
|
+
Signature: `list_intent_slots(strSessionID:)`
|
122
|
+
Invocation: `MemoriClient::Engine::V2::Intent.list_intent_slots(strSessionID:)`
|
123
|
+
|
124
|
+
HTTP API: GET /memori/v2/IntentSlots/{strSessionID}`
|
125
|
+
|
126
|
+
Parameters:
|
127
|
+
|
128
|
+
- `strSessionID`: **string** The session ID. required
|
129
|
+
|
130
|
+
## list_intent_slots_paginated
|
131
|
+
|
132
|
+
Summary:
|
133
|
+
Lists Intent Slot objects with pagination.
|
134
|
+
|
135
|
+
Signature: `list_intent_slots_paginated(strSessionID:, from:, howMany:)`
|
136
|
+
Invocation: `MemoriClient::Engine::V2::Intent.list_intent_slots_paginated(strSessionID:, from:, howMany:)`
|
137
|
+
|
138
|
+
HTTP API: GET /memori/v2/IntentSlots/{strSessionID}/{from}/{howMany}`
|
139
|
+
|
140
|
+
Parameters:
|
141
|
+
|
142
|
+
- `strSessionID`: **string** The session ID. required
|
143
|
+
- `from`: **integer** The 0-based index of the first Intent Slot object to list. required
|
144
|
+
- `howMany`: **integer** The number of the Intent Slot objects to list. required
|
145
|
+
|
146
|
+
## get_intent_slot
|
147
|
+
|
148
|
+
Summary:
|
149
|
+
Gets the details of an Intent Slot object.
|
150
|
+
|
151
|
+
Signature: `get_intent_slot(strSessionID:, strSlotID:)`
|
152
|
+
Invocation: `MemoriClient::Engine::V2::Intent.get_intent_slot(strSessionID:, strSlotID:)`
|
153
|
+
|
154
|
+
HTTP API: GET /memori/v2/IntentSlot/{strSessionID}/{strSlotID}`
|
155
|
+
|
156
|
+
Parameters:
|
157
|
+
|
158
|
+
- `strSessionID`: **string** The session ID. required
|
159
|
+
- `strSlotID`: **string** The Intent Slot object ID. required
|
160
|
+
|
161
|
+
## update_intent_slot
|
162
|
+
|
163
|
+
Summary:
|
164
|
+
Updates an existing Intent Slot object.
|
165
|
+
|
166
|
+
Signature: `update_intent_slot(strSessionID:, strSlotID:, payload: {})`
|
167
|
+
Invocation: `MemoriClient::Engine::V2::Intent.update_intent_slot(strSessionID:, strSlotID:, payload: {})`
|
168
|
+
|
169
|
+
HTTP API: PATCH /memori/v2/IntentSlot/{strSessionID}/{strSlotID}`
|
170
|
+
|
171
|
+
Parameters:
|
172
|
+
|
173
|
+
- `strSessionID`: **string** The session ID. required
|
174
|
+
- `strSlotID`: **string** The Intent Slot object ID. required
|
175
|
+
- `payload`: **Hash** request payload. optional
|
176
|
+
- `payload.intentSlotID`: **String** . optional
|
177
|
+
- `payload.name`: **String** . optional
|
178
|
+
- `payload.values`: **Array** . optional
|
179
|
+
- `payload.webHook`: **String** . optional
|
180
|
+
- `payload.validityMinutes`: **Number** . optional
|
181
|
+
- `payload.creationTimestamp`: **String** . optional
|
182
|
+
- `payload.creationSessionID`: **String** . optional
|
183
|
+
- `payload.lastChangeTimestamp`: **String** . optional
|
184
|
+
- `payload.lastChangeSessionID`: **String** . optional
|
185
|
+
|
186
|
+
## remove_intent_slot
|
187
|
+
|
188
|
+
Summary:
|
189
|
+
Removes an existing Intent Slot object.
|
190
|
+
|
191
|
+
Signature: `remove_intent_slot(strSessionID:, strSlotID:)`
|
192
|
+
Invocation: `MemoriClient::Engine::V2::Intent.remove_intent_slot(strSessionID:, strSlotID:)`
|
193
|
+
|
194
|
+
HTTP API: DELETE /memori/v2/IntentSlot/{strSessionID}/{strSlotID}`
|
195
|
+
|
196
|
+
Parameters:
|
197
|
+
|
198
|
+
- `strSessionID`: **string** The session ID. required
|
199
|
+
- `strSlotID`: **string** The Intent Slot object ID. required
|
200
|
+
|
201
|
+
## add_intent_slot
|
202
|
+
|
203
|
+
Summary:
|
204
|
+
Adds a new Intent Slot object.
|
205
|
+
|
206
|
+
Signature: `add_intent_slot(strSessionID:, payload: {})`
|
207
|
+
Invocation: `MemoriClient::Engine::V2::Intent.add_intent_slot(strSessionID:, payload: {})`
|
208
|
+
|
209
|
+
HTTP API: POST /memori/v2/IntentSlot/{strSessionID}`
|
210
|
+
|
211
|
+
Parameters:
|
212
|
+
|
213
|
+
- `strSessionID`: **string** The session ID. required
|
214
|
+
- `payload`: **Hash** request payload. optional
|
215
|
+
- `payload.intentSlotID`: **String** . optional
|
216
|
+
- `payload.name`: **String** . optional
|
217
|
+
- `payload.values`: **Array** . optional
|
218
|
+
- `payload.webHook`: **String** . optional
|
219
|
+
- `payload.validityMinutes`: **Number** . optional
|
220
|
+
- `payload.creationTimestamp`: **String** . optional
|
221
|
+
- `payload.creationSessionID`: **String** . optional
|
222
|
+
- `payload.lastChangeTimestamp`: **String** . optional
|
223
|
+
- `payload.lastChangeSessionID`: **String** . optional
|
224
|
+
|
225
|
+
|
@@ -0,0 +1,105 @@
|
|
1
|
+
# Module `MemoriClient::Engine::V2::LocalizationKey`
|
2
|
+
|
3
|
+
## list_localization_keys
|
4
|
+
|
5
|
+
Summary:
|
6
|
+
Lists all Localization Keys.
|
7
|
+
|
8
|
+
Signature: `list_localization_keys(strSessionID:)`
|
9
|
+
Invocation: `MemoriClient::Engine::V2::LocalizationKey.list_localization_keys(strSessionID:)`
|
10
|
+
|
11
|
+
HTTP API: GET /memori/v2/LocalizationKeys/{strSessionID}`
|
12
|
+
|
13
|
+
Parameters:
|
14
|
+
|
15
|
+
- `strSessionID`: **string** The session ID. required
|
16
|
+
|
17
|
+
## list_localization_keys_paginated
|
18
|
+
|
19
|
+
Summary:
|
20
|
+
Lists Localization Keys with pagination.
|
21
|
+
|
22
|
+
Signature: `list_localization_keys_paginated(strSessionID:, from:, howMany:)`
|
23
|
+
Invocation: `MemoriClient::Engine::V2::LocalizationKey.list_localization_keys_paginated(strSessionID:, from:, howMany:)`
|
24
|
+
|
25
|
+
HTTP API: GET /memori/v2/LocalizationKeys/{strSessionID}/{from}/{howMany}`
|
26
|
+
|
27
|
+
Parameters:
|
28
|
+
|
29
|
+
- `strSessionID`: **string** The session ID. required
|
30
|
+
- `from`: **integer** The 0-based index of the first Localization Key to list. required
|
31
|
+
- `howMany`: **integer** The number of the Localization Keys to list. required
|
32
|
+
|
33
|
+
## get_localization_key
|
34
|
+
|
35
|
+
Summary:
|
36
|
+
Get an existing Localization Key.
|
37
|
+
|
38
|
+
Signature: `get_localization_key(strSessionID:, strKey:)`
|
39
|
+
Invocation: `MemoriClient::Engine::V2::LocalizationKey.get_localization_key(strSessionID:, strKey:)`
|
40
|
+
|
41
|
+
HTTP API: GET /memori/v2/LocalizationKey/{strSessionID}/{strKey}`
|
42
|
+
|
43
|
+
Parameters:
|
44
|
+
|
45
|
+
- `strSessionID`: **string** The session ID. required
|
46
|
+
- `strKey`: **string** The key of the Localization Key. required
|
47
|
+
|
48
|
+
## remove_localization_key
|
49
|
+
|
50
|
+
Summary:
|
51
|
+
Removes an existing Localization Key.
|
52
|
+
|
53
|
+
Signature: `remove_localization_key(strSessionID:, strKey:)`
|
54
|
+
Invocation: `MemoriClient::Engine::V2::LocalizationKey.remove_localization_key(strSessionID:, strKey:)`
|
55
|
+
|
56
|
+
HTTP API: DELETE /memori/v2/LocalizationKey/{strSessionID}/{strKey}`
|
57
|
+
|
58
|
+
Parameters:
|
59
|
+
|
60
|
+
- `strSessionID`: **string** The session ID. required
|
61
|
+
- `strKey`: **string** The key of the Localization Key. required
|
62
|
+
|
63
|
+
## add_localization_key
|
64
|
+
|
65
|
+
Summary:
|
66
|
+
Add a new Localization Key.
|
67
|
+
|
68
|
+
Signature: `add_localization_key(strSessionID:, payload: {})`
|
69
|
+
Invocation: `MemoriClient::Engine::V2::LocalizationKey.add_localization_key(strSessionID:, payload: {})`
|
70
|
+
|
71
|
+
HTTP API: POST /memori/v2/LocalizationKey/{strSessionID}`
|
72
|
+
|
73
|
+
Parameters:
|
74
|
+
|
75
|
+
- `strSessionID`: **string** The session ID. required
|
76
|
+
- `payload`: **Hash** request payload. optional
|
77
|
+
- `payload.key`: **String** . optional
|
78
|
+
- `payload.value`: **String** . optional
|
79
|
+
- `payload.creationTimestamp`: **String** . optional
|
80
|
+
- `payload.creationSessionID`: **String** . optional
|
81
|
+
- `payload.lastChangeTimestamp`: **String** . optional
|
82
|
+
- `payload.lastChangeSessionID`: **String** . optional
|
83
|
+
|
84
|
+
## update_localization_key
|
85
|
+
|
86
|
+
Summary:
|
87
|
+
Updates an existing Localization Key.
|
88
|
+
|
89
|
+
Signature: `update_localization_key(strSessionID:, payload: {})`
|
90
|
+
Invocation: `MemoriClient::Engine::V2::LocalizationKey.update_localization_key(strSessionID:, payload: {})`
|
91
|
+
|
92
|
+
HTTP API: PATCH /memori/v2/LocalizationKey/{strSessionID}`
|
93
|
+
|
94
|
+
Parameters:
|
95
|
+
|
96
|
+
- `strSessionID`: **string** The session ID. required
|
97
|
+
- `payload`: **Hash** request payload. optional
|
98
|
+
- `payload.key`: **String** . optional
|
99
|
+
- `payload.value`: **String** . optional
|
100
|
+
- `payload.creationTimestamp`: **String** . optional
|
101
|
+
- `payload.creationSessionID`: **String** . optional
|
102
|
+
- `payload.lastChangeTimestamp`: **String** . optional
|
103
|
+
- `payload.lastChangeSessionID`: **String** . optional
|
104
|
+
|
105
|
+
|
@@ -0,0 +1,118 @@
|
|
1
|
+
# Module `MemoriClient::Engine::V2::Medium`
|
2
|
+
|
3
|
+
## list_media
|
4
|
+
|
5
|
+
Summary:
|
6
|
+
Lists all Medium objects of a Memory.
|
7
|
+
|
8
|
+
Signature: `list_media(strSessionID:, strMemoryID:)`
|
9
|
+
Invocation: `MemoriClient::Engine::V2::Medium.list_media(strSessionID:, strMemoryID:)`
|
10
|
+
|
11
|
+
HTTP API: GET /memori/v2/Media/{strSessionID}/{strMemoryID}`
|
12
|
+
|
13
|
+
Parameters:
|
14
|
+
|
15
|
+
- `strSessionID`: **string** The session ID. required
|
16
|
+
- `strMemoryID`: **string** The Memory object ID. required
|
17
|
+
|
18
|
+
## remove_media
|
19
|
+
|
20
|
+
Summary:
|
21
|
+
Removes all Medium objects from a Memory.
|
22
|
+
|
23
|
+
Signature: `remove_media(strSessionID:, strMemoryID:)`
|
24
|
+
Invocation: `MemoriClient::Engine::V2::Medium.remove_media(strSessionID:, strMemoryID:)`
|
25
|
+
|
26
|
+
HTTP API: DELETE /memori/v2/Media/{strSessionID}/{strMemoryID}`
|
27
|
+
|
28
|
+
Parameters:
|
29
|
+
|
30
|
+
- `strSessionID`: **string** The session ID. required
|
31
|
+
- `strMemoryID`: **string** The Memory object ID. required
|
32
|
+
|
33
|
+
## get_medium
|
34
|
+
|
35
|
+
Summary:
|
36
|
+
Gets the details of a Medium object of a Memory.
|
37
|
+
|
38
|
+
Signature: `get_medium(strSessionID:, strMemoryID:, strMediumID:)`
|
39
|
+
Invocation: `MemoriClient::Engine::V2::Medium.get_medium(strSessionID:, strMemoryID:, strMediumID:)`
|
40
|
+
|
41
|
+
HTTP API: GET /memori/v2/Medium/{strSessionID}/{strMemoryID}/{strMediumID}`
|
42
|
+
|
43
|
+
Parameters:
|
44
|
+
|
45
|
+
- `strSessionID`: **string** The session ID. required
|
46
|
+
- `strMemoryID`: **string** The Memory object ID. required
|
47
|
+
- `strMediumID`: **string** The Medium object ID. required
|
48
|
+
|
49
|
+
## update_media
|
50
|
+
|
51
|
+
Summary:
|
52
|
+
Updates an existing Medium object of a Memory.
|
53
|
+
|
54
|
+
Signature: `update_media(strSessionID:, strMemoryID:, strMediumID:, payload: {})`
|
55
|
+
Invocation: `MemoriClient::Engine::V2::Medium.update_media(strSessionID:, strMemoryID:, strMediumID:, payload: {})`
|
56
|
+
|
57
|
+
HTTP API: PATCH /memori/v2/Medium/{strSessionID}/{strMemoryID}/{strMediumID}`
|
58
|
+
|
59
|
+
Parameters:
|
60
|
+
|
61
|
+
- `strSessionID`: **string** The session ID. required
|
62
|
+
- `strMemoryID`: **string** The Memory object ID. required
|
63
|
+
- `strMediumID`: **string** The Medium object ID. required
|
64
|
+
- `payload`: **Hash** request payload. optional
|
65
|
+
- `payload.mediumID`: **String** . optional
|
66
|
+
- `payload.url`: **String** . optional
|
67
|
+
- `payload.content`: **String** . optional
|
68
|
+
- `payload.mimeType`: **String** . optional
|
69
|
+
- `payload.title`: **String** . optional
|
70
|
+
- `payload.properties`: **Object** . optional
|
71
|
+
- `payload.creationTimestamp`: **String** . optional
|
72
|
+
- `payload.creationSessionID`: **String** . optional
|
73
|
+
- `payload.lastChangeTimestamp`: **String** . optional
|
74
|
+
- `payload.lastChangeSessionID`: **String** . optional
|
75
|
+
|
76
|
+
## remove_medium
|
77
|
+
|
78
|
+
Summary:
|
79
|
+
Removes an existing Medium object from a Memory.
|
80
|
+
|
81
|
+
Signature: `remove_medium(strSessionID:, strMemoryID:, strMediumID:)`
|
82
|
+
Invocation: `MemoriClient::Engine::V2::Medium.remove_medium(strSessionID:, strMemoryID:, strMediumID:)`
|
83
|
+
|
84
|
+
HTTP API: DELETE /memori/v2/Medium/{strSessionID}/{strMemoryID}/{strMediumID}`
|
85
|
+
|
86
|
+
Parameters:
|
87
|
+
|
88
|
+
- `strSessionID`: **string** The session ID. required
|
89
|
+
- `strMemoryID`: **string** The Memory object ID. required
|
90
|
+
- `strMediumID`: **string** The Medium object ID. required
|
91
|
+
|
92
|
+
## add_media
|
93
|
+
|
94
|
+
Summary:
|
95
|
+
Adds a new Medium object to a Memory.
|
96
|
+
|
97
|
+
Signature: `add_media(strSessionID:, strMemoryID:, payload: {})`
|
98
|
+
Invocation: `MemoriClient::Engine::V2::Medium.add_media(strSessionID:, strMemoryID:, payload: {})`
|
99
|
+
|
100
|
+
HTTP API: POST /memori/v2/Medium/{strSessionID}/{strMemoryID}`
|
101
|
+
|
102
|
+
Parameters:
|
103
|
+
|
104
|
+
- `strSessionID`: **string** The session ID. required
|
105
|
+
- `strMemoryID`: **string** The Memory object ID. required
|
106
|
+
- `payload`: **Hash** request payload. optional
|
107
|
+
- `payload.mediumID`: **String** . optional
|
108
|
+
- `payload.url`: **String** . optional
|
109
|
+
- `payload.content`: **String** . optional
|
110
|
+
- `payload.mimeType`: **String** . optional
|
111
|
+
- `payload.title`: **String** . optional
|
112
|
+
- `payload.properties`: **Object** . optional
|
113
|
+
- `payload.creationTimestamp`: **String** . optional
|
114
|
+
- `payload.creationSessionID`: **String** . optional
|
115
|
+
- `payload.lastChangeTimestamp`: **String** . optional
|
116
|
+
- `payload.lastChangeSessionID`: **String** . optional
|
117
|
+
|
118
|
+
|