memori-client 0.1.1 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/lib/memori_client/backend/resources.rb +3 -0
  3. data/lib/memori_client/backend/v1/asset.rb +51 -25
  4. data/lib/memori_client/backend/v2/action_log.rb +19 -7
  5. data/lib/memori_client/backend/v2/analysis.rb +54 -0
  6. data/lib/memori_client/backend/v2/asset.rb +79 -23
  7. data/lib/memori_client/backend/v2/badge.rb +34 -17
  8. data/lib/memori_client/backend/v2/completion_config.rb +202 -0
  9. data/lib/memori_client/backend/v2/consumption_log.rb +31 -10
  10. data/lib/memori_client/backend/v2/import_export.rb +244 -80
  11. data/lib/memori_client/backend/v2/integration.rb +95 -47
  12. data/lib/memori_client/backend/v2/invitation.rb +127 -61
  13. data/lib/memori_client/backend/v2/memori.rb +652 -313
  14. data/lib/memori_client/backend/v2/memori_list.rb +65 -31
  15. data/lib/memori_client/backend/v2/notification.rb +13 -7
  16. data/lib/memori_client/backend/v2/process.rb +70 -0
  17. data/lib/memori_client/backend/v2/tenant.rb +192 -102
  18. data/lib/memori_client/backend/v2/user.rb +1058 -547
  19. data/lib/memori_client/configuration.rb +5 -0
  20. data/lib/memori_client/engine/hmac_helper.rb +186 -0
  21. data/lib/memori_client/engine/resource.rb +5 -31
  22. data/lib/memori_client/engine/resources.rb +2 -3
  23. data/lib/memori_client/engine/v2/chat_log.rb +51 -13
  24. data/lib/memori_client/engine/v2/context_var.rb +20 -10
  25. data/lib/memori_client/engine/v2/correlation_pair.rb +48 -23
  26. data/lib/memori_client/engine/v2/custom_dictionary.rb +74 -35
  27. data/lib/memori_client/engine/v2/dialog.rb +107 -57
  28. data/lib/memori_client/engine/v2/event_log.rb +54 -13
  29. data/lib/memori_client/engine/v2/expert_reference.rb +92 -45
  30. data/lib/memori_client/engine/v2/function.rb +220 -0
  31. data/lib/memori_client/engine/v2/intent.rb +175 -85
  32. data/lib/memori_client/engine/v2/localization_key.rb +72 -36
  33. data/lib/memori_client/engine/v2/medium.rb +92 -43
  34. data/lib/memori_client/engine/v2/memory.rb +341 -89
  35. data/lib/memori_client/engine/v2/nlp.rb +65 -128
  36. data/lib/memori_client/engine/v2/person.rb +88 -43
  37. data/lib/memori_client/engine/v2/private/memori.rb +17 -0
  38. data/lib/memori_client/engine/v2/private/memori_block.rb +24 -0
  39. data/lib/memori_client/engine/v2/search.rb +240 -52
  40. data/lib/memori_client/engine/v2/session.rb +41 -22
  41. data/lib/memori_client/engine/v2/stat.rb +8 -40
  42. data/lib/memori_client/engine/v2/topic.rb +88 -0
  43. data/lib/memori_client/engine/v2/unanswered_question.rb +54 -26
  44. data/lib/memori_client/engine/v2/user.rb +114 -14
  45. data/lib/memori_client/engine/v2/web_hook.rb +80 -34
  46. data/lib/memori_client/http_client.rb +8 -1
  47. data/lib/memori_client/resource.rb +3 -2
  48. data/lib/memori_client.rb +6 -0
  49. metadata +10 -2
@@ -1,162 +1,326 @@
1
- # Generated on 2024-01-18 17:37:06 +0000
1
+ # Generated on 2025-01-27 20:29:51 +0000
2
2
  class MemoriClient::Backend::V2::ImportExport < MemoriClient::Backend::Resource
3
- # POST /api/v2/ImportExport/ImportCSV/{strToken}/{strMemoriID}
3
+ # `POST /api/v2/ImportExport/ImportCSV/{strToken}/{strMemoriID}`
4
+ #
4
5
  # Starts an Import process for memories from a CSV file.
5
- # Params list:
6
+ #
7
+ #
6
8
  # @param [string] strToken The login token. required
9
+ #
7
10
  # @param [string] strMemoriID The ID of the Memori object. required
8
- # @param [object] payload request payload. optional
9
- # @param [] payload.csvSpecs . required
10
- # @param [array] payload.rows . required
11
- # @param [string] payload.importName . optional
12
- # @param [boolean] payload.forceImport . optional
13
- # @param [boolean] payload.conclusive . optional
14
- # @param [boolean] payload.notPickable . optional
15
- # @param [object] payload.contextVarsToSet . optional
16
- # @param [object] payload.contextVarsToMatch . optional
17
- # @param [string] payload.notes . optional
18
- # import_csv(strToken:, strMemoriID:, payload: {})
11
+ #
12
+ # @param [Hash] payload request payload. optional
13
+ #
14
+ # @param [] payload.csvSpecs . optional
15
+ #
16
+ # @param [Boolean] payload.conclusive . optional
17
+ #
18
+ # @param [Boolean] payload.notPickable . optional
19
+ #
20
+ # @param [Object] payload.contextVarsToSet . optional
21
+ #
22
+ # @param [Object] payload.contextVarsToMatch . optional
23
+ #
24
+ # @param [Array] payload.memoryTags . optional
25
+ #
26
+ # @param [String] payload.receiverID . optional
27
+ #
28
+ # @param [String] payload.addMediaLink . optional
29
+ #
30
+ # @param [String] payload.linkTitleHandling . optional
31
+ #
32
+ # @param [String] payload.linkTitle . optional
33
+ #
34
+ # @param [Array] payload.rows . optional
35
+ #
36
+ # @param [String] payload.importName . optional
37
+ #
38
+ # @param [Boolean] payload.forceImport . optional
39
+ #
40
+ # @param [String] payload.notes . optional
41
+ #
42
+ # `import_csv(strToken:, strMemoriID:, payload: {})`
19
43
  def self.import_csv(strToken:, strMemoriID:, payload: {})
20
44
  args = build_arguments(binding)
21
45
  payload_keys = [
46
+ 'addMediaLink',
22
47
  'conclusive',
23
48
  'contextVarsToMatch',
24
49
  'contextVarsToSet',
25
50
  'csvSpecs',
26
51
  'forceImport',
27
52
  'importName',
53
+ 'linkTitle',
54
+ 'linkTitleHandling',
55
+ 'memoryTags',
28
56
  'notPickable',
29
57
  'notes',
58
+ 'receiverID',
30
59
  'rows',
31
60
  ]
32
- payload_required_keys = %w[csvSpecs rows]
61
+ payload_required_keys = %w[]
33
62
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
34
63
 
35
64
  exec_http_request('post', '/api/v2/ImportExport/ImportCSV/{strToken}/{strMemoriID}', **args)
36
65
  end
37
66
 
38
- # POST /api/v2/ImportExport/ImportTXT/{strToken}/{strMemoriID}
67
+ # `POST /api/v2/ImportExport/ImportTXT/{strToken}/{strMemoriID}`
68
+ #
39
69
  # Starts an Import process for memories from a TXT file.
40
- # Params list:
70
+ #
71
+ #
41
72
  # @param [string] strToken The login token. required
73
+ #
42
74
  # @param [string] strMemoriID The ID of the Memori object. required
43
- # @param [object] payload request payload. optional
44
- # @param [] payload.txtSpecs . required
45
- # @param [array] payload.rows . required
46
- # @param [string] payload.importName . optional
47
- # @param [boolean] payload.forceImport . optional
48
- # @param [boolean] payload.conclusive . optional
49
- # @param [boolean] payload.notPickable . optional
50
- # @param [object] payload.contextVarsToSet . optional
51
- # @param [object] payload.contextVarsToMatch . optional
52
- # @param [string] payload.notes . optional
53
- # import_txt(strToken:, strMemoriID:, payload: {})
75
+ #
76
+ # @param [Hash] payload request payload. optional
77
+ #
78
+ # @param [] payload.txtSpecs . optional
79
+ #
80
+ # @param [Boolean] payload.conclusive . optional
81
+ #
82
+ # @param [Boolean] payload.notPickable . optional
83
+ #
84
+ # @param [Object] payload.contextVarsToSet . optional
85
+ #
86
+ # @param [Object] payload.contextVarsToMatch . optional
87
+ #
88
+ # @param [Array] payload.memoryTags . optional
89
+ #
90
+ # @param [String] payload.receiverID . optional
91
+ #
92
+ # @param [String] payload.addMediaLink . optional
93
+ #
94
+ # @param [String] payload.linkTitleHandling . optional
95
+ #
96
+ # @param [String] payload.linkTitle . optional
97
+ #
98
+ # @param [Array] payload.rows . optional
99
+ #
100
+ # @param [String] payload.importName . optional
101
+ #
102
+ # @param [Boolean] payload.forceImport . optional
103
+ #
104
+ # @param [String] payload.notes . optional
105
+ #
106
+ # `import_txt(strToken:, strMemoriID:, payload: {})`
54
107
  def self.import_txt(strToken:, strMemoriID:, payload: {})
55
108
  args = build_arguments(binding)
56
109
  payload_keys = [
110
+ 'addMediaLink',
57
111
  'conclusive',
58
112
  'contextVarsToMatch',
59
113
  'contextVarsToSet',
60
114
  'forceImport',
61
115
  'importName',
116
+ 'linkTitle',
117
+ 'linkTitleHandling',
118
+ 'memoryTags',
62
119
  'notPickable',
63
120
  'notes',
121
+ 'receiverID',
64
122
  'rows',
65
123
  'txtSpecs',
66
124
  ]
67
- payload_required_keys = %w[rows txtSpecs]
125
+ payload_required_keys = %w[]
68
126
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
69
127
 
70
128
  exec_http_request('post', '/api/v2/ImportExport/ImportTXT/{strToken}/{strMemoriID}', **args)
71
129
  end
72
130
 
73
- # GET /api/v2/ImportExport/ImportProcesses/{strToken}
74
- # Gets a list of Import processes started by the currently logged in User.
75
- # Params list:
131
+ # `POST /api/v2/ImportExport/ImportFunctionsIntents/{strToken}/{strMemoriID}`
132
+ #
133
+ # Starts an Import process for functions and intents from a jsonl file.
134
+ #
135
+ #
76
136
  # @param [string] strToken The login token. required
77
- # list_import_processes(strToken:)
78
- def self.list_import_processes(strToken:)
137
+ #
138
+ # @param [string] strMemoriID The ID of the Memori object. required
139
+ #
140
+ # @param [Hash] payload request payload. optional
141
+ #
142
+ # @param [Array] payload.rows . optional
143
+ #
144
+ # @param [String] payload.importName . optional
145
+ #
146
+ # @param [Boolean] payload.forceImport . optional
147
+ #
148
+ # @param [String] payload.notes . optional
149
+ #
150
+ # `import_functions_intents(strToken:, strMemoriID:, payload: {})`
151
+ def self.import_functions_intents(strToken:, strMemoriID:, payload: {})
79
152
  args = build_arguments(binding)
153
+ payload_keys = [
154
+ 'forceImport',
155
+ 'importName',
156
+ 'notes',
157
+ 'rows',
158
+ ]
159
+ payload_required_keys = %w[]
160
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
80
161
 
81
- exec_http_request('get', '/api/v2/ImportExport/ImportProcesses/{strToken}', **args)
162
+ exec_http_request('post', '/api/v2/ImportExport/ImportFunctionsIntents/{strToken}/{strMemoriID}', **args)
82
163
  end
83
164
 
84
- # GET /api/v2/ImportExport/MemoriImportProcesses/{strToken}/{strMemoriID}
85
- # Gets a list of Import processes for the specified Memori.
86
- # Params list:
165
+ # `POST /api/v2/ImportExport/ExportCSV/{strToken}/{strMemoriID}`
166
+ #
167
+ # Exports contents of a Memori object to a CSV file.
168
+ #
169
+ #
87
170
  # @param [string] strToken The login token. required
171
+ #
88
172
  # @param [string] strMemoriID The ID of the Memori object. required
89
- # list_memori_import_processes(strToken:, strMemoriID:)
90
- def self.list_memori_import_processes(strToken:, strMemoriID:)
173
+ #
174
+ # @param [Hash] payload request payload. optional
175
+ #
176
+ # @param [] payload.csvSpecs . optional
177
+ #
178
+ # @param [String] payload.password . optional
179
+ #
180
+ # `export_csv(strToken:, strMemoriID:, payload: {})`
181
+ def self.export_csv(strToken:, strMemoriID:, payload: {})
91
182
  args = build_arguments(binding)
183
+ payload_keys = [
184
+ 'csvSpecs',
185
+ 'password',
186
+ ]
187
+ payload_required_keys = %w[]
188
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
92
189
 
93
- exec_http_request('get', '/api/v2/ImportExport/MemoriImportProcesses/{strToken}/{strMemoriID}', **args)
190
+ exec_http_request('post', '/api/v2/ImportExport/ExportCSV/{strToken}/{strMemoriID}', **args)
94
191
  end
95
192
 
96
- # GET /api/v2/ImportExport/ImportStatus/{strToken}/{strImportID}
97
- # Gets the status of an Import process.
98
- # Params list:
193
+ # `POST /api/v2/ImportExport/ExportJSONL/{strToken}/{strMemoriID}`
194
+ #
195
+ # Exports contents of a Memori object to a JSONL file, suitable for fine-tuning with generative AI platforms.
196
+ #
197
+ #
99
198
  # @param [string] strToken The login token. required
100
- # @param [string] strImportID The Import process ID. required
101
- # get_import_status(strToken:, strImportID:)
102
- def self.get_import_status(strToken:, strImportID:)
199
+ #
200
+ # @param [string] strMemoriID The ID of the Memori object. required
201
+ #
202
+ # @param [Hash] payload request payload. optional
203
+ #
204
+ # @param [] payload.jsonlSpecs . optional
205
+ #
206
+ # @param [String] payload.password . optional
207
+ #
208
+ # `export_jsonl(strToken:, strMemoriID:, payload: {})`
209
+ def self.export_jsonl(strToken:, strMemoriID:, payload: {})
103
210
  args = build_arguments(binding)
211
+ payload_keys = [
212
+ 'jsonlSpecs',
213
+ 'password',
214
+ ]
215
+ payload_required_keys = %w[]
216
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
104
217
 
105
- exec_http_request('get', '/api/v2/ImportExport/ImportStatus/{strToken}/{strImportID}', **args)
218
+ exec_http_request('post', '/api/v2/ImportExport/ExportJSONL/{strToken}/{strMemoriID}', **args)
106
219
  end
107
220
 
108
- # POST /api/v2/ImportExport/StopImport/{strToken}/{strImportID}
109
- # Interrupts an ongoing Import process.
110
- # Params list:
221
+ # `POST /api/v2/ImportExport/ExportFunctionsIntents/{strToken}/{strMemoriID}`
222
+ #
223
+ # Exports functions, intents and intentSlots of a Memori object to a JSONL file
224
+ #
225
+ #
111
226
  # @param [string] strToken The login token. required
112
- # @param [string] strImportID The Import process ID. required
113
- # stop_import(strToken:, strImportID:)
114
- def self.stop_import(strToken:, strImportID:)
227
+ #
228
+ # @param [string] strMemoriID The ID of the Memori object. required
229
+ #
230
+ # @param [Hash] payload request payload. optional
231
+ #
232
+ # @param [Boolean] payload.exportFunctions . optional
233
+ #
234
+ # @param [Boolean] payload.exportIntents . optional
235
+ #
236
+ # @param [Boolean] payload.exportIntentSlots . optional
237
+ #
238
+ # @param [Array] payload.functionsIds . optional
239
+ #
240
+ # @param [Array] payload.intentsIds . optional
241
+ #
242
+ # @param [Array] payload.intentSlotsIds . optional
243
+ #
244
+ # @param [String] payload.password . optional
245
+ #
246
+ # `export_functions_intents(strToken:, strMemoriID:, payload: {})`
247
+ def self.export_functions_intents(strToken:, strMemoriID:, payload: {})
115
248
  args = build_arguments(binding)
249
+ payload_keys = [
250
+ 'exportFunctions',
251
+ 'exportIntentSlots',
252
+ 'exportIntents',
253
+ 'functionsIds',
254
+ 'intentSlotsIds',
255
+ 'intentsIds',
256
+ 'password',
257
+ ]
258
+ payload_required_keys = %w[]
259
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
116
260
 
117
- exec_http_request('post', '/api/v2/ImportExport/StopImport/{strToken}/{strImportID}', **args)
261
+ exec_http_request('post', '/api/v2/ImportExport/ExportFunctionsIntents/{strToken}/{strMemoriID}', **args)
118
262
  end
119
263
 
120
- # POST /api/v2/ImportExport/ExportCSV/{strToken}/{strMemoriID}
121
- # Exports contents of a Memori object to a CSV file.
122
- # Params list:
123
- # @param [string] strToken The login token. required
124
- # @param [string] strMemoriID The ID of the Memori object. required
125
- # @param [object] payload request payload. optional
126
- # @param [] payload.csvSpecs . required
127
- # @param [string] payload.password . optional
128
- # export_csv(strToken:, strMemoriID:, payload: {})
129
- def self.export_csv(strToken:, strMemoriID:, payload: {})
264
+ # `POST /api/v2/ImportExport/ImportDictionary/{strToken}/{strMemoriID}`
265
+ #
266
+ # Imports a dictionary to a Memori object.
267
+ #
268
+ #
269
+ # @param [string] strToken . required
270
+ #
271
+ # @param [string] strMemoriID . required
272
+ #
273
+ # @param [Hash] payload request payload. optional
274
+ #
275
+ # @param [Array] payload.rows . optional
276
+ #
277
+ # @param [String] payload.importName . optional
278
+ #
279
+ # @param [Boolean] payload.forceImport . optional
280
+ #
281
+ # @param [String] payload.notes . optional
282
+ #
283
+ # `import_dictionary(strToken:, strMemoriID:, payload: {})`
284
+ def self.import_dictionary(strToken:, strMemoriID:, payload: {})
130
285
  args = build_arguments(binding)
131
286
  payload_keys = [
132
- 'csvSpecs',
133
- 'password',
287
+ 'forceImport',
288
+ 'importName',
289
+ 'notes',
290
+ 'rows',
134
291
  ]
135
- payload_required_keys = %w[csvSpecs]
292
+ payload_required_keys = %w[]
136
293
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
137
294
 
138
- exec_http_request('post', '/api/v2/ImportExport/ExportCSV/{strToken}/{strMemoriID}', **args)
295
+ exec_http_request('post', '/api/v2/ImportExport/ImportDictionary/{strToken}/{strMemoriID}', **args)
139
296
  end
140
297
 
141
- # POST /api/v2/ImportExport/ExportJSONL/{strToken}/{strMemoriID}
142
- # Exports contents of a Memori object to a JSONL file, suitable for fine-tuning with generative AI platforms.
143
- # Params list:
298
+ # `POST /api/v2/ImportExport/ExportDictionary/{strToken}/{strMemoriID}`
299
+ #
300
+ # Exports the dictionary of a Memori object to a JSONL file.
301
+ #
302
+ #
144
303
  # @param [string] strToken The login token. required
304
+ #
145
305
  # @param [string] strMemoriID The ID of the Memori object. required
146
- # @param [object] payload request payload. optional
147
- # @param [] payload.jsonlSpecs . required
148
- # @param [string] payload.password . optional
149
- # export_jsonl(strToken:, strMemoriID:, payload: {})
150
- def self.export_jsonl(strToken:, strMemoriID:, payload: {})
306
+ #
307
+ # @param [Hash] payload request payload. optional
308
+ #
309
+ # @param [] payload.dictionarySpecs . optional
310
+ #
311
+ # @param [String] payload.password . optional
312
+ #
313
+ # `export_dictionary(strToken:, strMemoriID:, payload: {})`
314
+ def self.export_dictionary(strToken:, strMemoriID:, payload: {})
151
315
  args = build_arguments(binding)
152
316
  payload_keys = [
153
- 'jsonlSpecs',
317
+ 'dictionarySpecs',
154
318
  'password',
155
319
  ]
156
- payload_required_keys = %w[jsonlSpecs]
320
+ payload_required_keys = %w[]
157
321
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
158
322
 
159
- exec_http_request('post', '/api/v2/ImportExport/ExportJSONL/{strToken}/{strMemoriID}', **args)
323
+ exec_http_request('post', '/api/v2/ImportExport/ExportDictionary/{strToken}/{strMemoriID}', **args)
160
324
  end
161
325
 
162
326
 
@@ -1,59 +1,87 @@
1
- # Generated on 2024-01-18 17:37:06 +0000
1
+ # Generated on 2025-01-27 20:29:51 +0000
2
2
  class MemoriClient::Backend::V2::Integration < MemoriClient::Backend::Resource
3
- # GET /api/v2/Integrations/{strToken}/{strMemoriID}
3
+ # `GET /api/v2/Integrations/{strToken}/{strMemoriID}`
4
+ #
4
5
  # Gets a list of Integration objects for a specified Memori object.
5
- # Params list:
6
+ #
7
+ #
6
8
  # @param [string] strToken The login token. required
9
+ #
7
10
  # @param [string] strMemoriID The ID of the Memori object. required
8
- # list_integrations(strToken:, strMemoriID:)
11
+ #
12
+ # `list_integrations(strToken:, strMemoriID:)`
9
13
  def self.list_integrations(strToken:, strMemoriID:)
10
14
  args = build_arguments(binding)
11
15
 
12
16
  exec_http_request('get', '/api/v2/Integrations/{strToken}/{strMemoriID}', **args)
13
17
  end
14
18
 
15
- # GET /api/v2/AllIntegrations/{strToken}
19
+ # `GET /api/v2/AllIntegrations/{strToken}`
20
+ #
16
21
  # Gets a list of all Integration objects.
17
- # Params list:
22
+ #
23
+ #
18
24
  # @param [string] strToken The login token. required
19
- # list_all_integrations(strToken:)
25
+ #
26
+ # `list_all_integrations(strToken:)`
20
27
  def self.list_all_integrations(strToken:)
21
28
  args = build_arguments(binding)
22
29
 
23
30
  exec_http_request('get', '/api/v2/AllIntegrations/{strToken}', **args)
24
31
  end
25
32
 
26
- # GET /api/v2/Integration/{strToken}/{strIntegrationID}
33
+ # `GET /api/v2/Integration/{strToken}/{strIntegrationID}`
34
+ #
27
35
  # Gets the details of an Integration object of the currently logged in User.
28
- # Params list:
36
+ #
37
+ #
29
38
  # @param [string] strToken The login token. required
39
+ #
30
40
  # @param [string] strIntegrationID The ID of the Integration object. required
31
- # get_integration(strToken:, strIntegrationID:)
41
+ #
42
+ # `get_integration(strToken:, strIntegrationID:)`
32
43
  def self.get_integration(strToken:, strIntegrationID:)
33
44
  args = build_arguments(binding)
34
45
 
35
46
  exec_http_request('get', '/api/v2/Integration/{strToken}/{strIntegrationID}', **args)
36
47
  end
37
48
 
38
- # PATCH /api/v2/Integration/{strToken}/{strIntegrationID}
49
+ # `PATCH /api/v2/Integration/{strToken}/{strIntegrationID}`
50
+ #
39
51
  # Updates an existing Integration object.
40
- # Params list:
52
+ #
53
+ #
41
54
  # @param [string] strToken The login token. required
55
+ #
42
56
  # @param [string] strIntegrationID The Integration object ID. required
43
- # @param [object] payload request payload. optional
44
- # @param [string] payload.integrationID . optional
45
- # @param [string] payload.memoriID . required
46
- # @param [string] payload.type . required
47
- # @param [string] payload.state . optional
48
- # @param [array] payload.deviceEmails . optional
49
- # @param [string] payload.invocationText . optional
50
- # @param [string] payload.jobID . optional
51
- # @param [string] payload.customData . optional
52
- # @param [array] payload.resources . optional
53
- # @param [boolean] payload.publish . optional
54
- # @param [string] payload.creationTimestamp . optional
55
- # @param [string] payload.lastChangeTimestamp . optional
56
- # update_integration(strToken:, strIntegrationID:, payload: {})
57
+ #
58
+ # @param [Hash] payload request payload. optional
59
+ #
60
+ # @param [String] payload.integrationID . optional
61
+ #
62
+ # @param [String] payload.memoriID . optional
63
+ #
64
+ # @param [String] payload.type . optional
65
+ #
66
+ # @param [String] payload.state . optional
67
+ #
68
+ # @param [Array] payload.deviceEmails . optional
69
+ #
70
+ # @param [String] payload.invocationText . optional
71
+ #
72
+ # @param [String] payload.jobID . optional
73
+ #
74
+ # @param [String] payload.customData . optional
75
+ #
76
+ # @param [Array] payload.resources . optional
77
+ #
78
+ # @param [Boolean] payload.publish . optional
79
+ #
80
+ # @param [String] payload.creationTimestamp . optional
81
+ #
82
+ # @param [String] payload.lastChangeTimestamp . optional
83
+ #
84
+ # `update_integration(strToken:, strIntegrationID:, payload: {})`
57
85
  def self.update_integration(strToken:, strIntegrationID:, payload: {})
58
86
  args = build_arguments(binding)
59
87
  payload_keys = [
@@ -70,42 +98,62 @@ class MemoriClient::Backend::V2::Integration < MemoriClient::Backend::Resource
70
98
  'state',
71
99
  'type',
72
100
  ]
73
- payload_required_keys = %w[memoriID type]
101
+ payload_required_keys = %w[]
74
102
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
75
103
 
76
104
  exec_http_request('patch', '/api/v2/Integration/{strToken}/{strIntegrationID}', **args)
77
105
  end
78
106
 
79
- # DELETE /api/v2/Integration/{strToken}/{strIntegrationID}
107
+ # `DELETE /api/v2/Integration/{strToken}/{strIntegrationID}`
108
+ #
80
109
  # Deletes an existing Integration object.
81
- # Params list:
110
+ #
111
+ #
82
112
  # @param [string] strToken The login token. required
113
+ #
83
114
  # @param [string] strIntegrationID The Integration object ID. required
84
- # delete_integration(strToken:, strIntegrationID:)
115
+ #
116
+ # `delete_integration(strToken:, strIntegrationID:)`
85
117
  def self.delete_integration(strToken:, strIntegrationID:)
86
118
  args = build_arguments(binding)
87
119
 
88
120
  exec_http_request('delete', '/api/v2/Integration/{strToken}/{strIntegrationID}', **args)
89
121
  end
90
122
 
91
- # POST /api/v2/Integration/{strToken}
123
+ # `POST /api/v2/Integration/{strToken}`
124
+ #
92
125
  # Registers a new Integration object.
93
- # Params list:
126
+ #
127
+ #
94
128
  # @param [string] strToken The login token. required
95
- # @param [object] payload request payload. optional
96
- # @param [string] payload.integrationID . optional
97
- # @param [string] payload.memoriID . required
98
- # @param [string] payload.type . required
99
- # @param [string] payload.state . optional
100
- # @param [array] payload.deviceEmails . optional
101
- # @param [string] payload.invocationText . optional
102
- # @param [string] payload.jobID . optional
103
- # @param [string] payload.customData . optional
104
- # @param [array] payload.resources . optional
105
- # @param [boolean] payload.publish . optional
106
- # @param [string] payload.creationTimestamp . optional
107
- # @param [string] payload.lastChangeTimestamp . optional
108
- # register_integration(strToken:, payload: {})
129
+ #
130
+ # @param [Hash] payload request payload. optional
131
+ #
132
+ # @param [String] payload.integrationID . optional
133
+ #
134
+ # @param [String] payload.memoriID . optional
135
+ #
136
+ # @param [String] payload.type . optional
137
+ #
138
+ # @param [String] payload.state . optional
139
+ #
140
+ # @param [Array] payload.deviceEmails . optional
141
+ #
142
+ # @param [String] payload.invocationText . optional
143
+ #
144
+ # @param [String] payload.jobID . optional
145
+ #
146
+ # @param [String] payload.customData . optional
147
+ #
148
+ # @param [Array] payload.resources . optional
149
+ #
150
+ # @param [Boolean] payload.publish . optional
151
+ #
152
+ # @param [String] payload.creationTimestamp . optional
153
+ #
154
+ # @param [String] payload.lastChangeTimestamp . optional
155
+ #
156
+ # `register_integration(strToken:, payload: {})`
109
157
  def self.register_integration(strToken:, payload: {})
110
158
  args = build_arguments(binding)
111
159
  payload_keys = [
@@ -122,7 +170,7 @@ class MemoriClient::Backend::V2::Integration < MemoriClient::Backend::Resource
122
170
  'state',
123
171
  'type',
124
172
  ]
125
- payload_required_keys = %w[memoriID type]
173
+ payload_required_keys = %w[]
126
174
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
127
175
 
128
176
  exec_http_request('post', '/api/v2/Integration/{strToken}', **args)