Class: MemoriClient::Engine::V2::Memory

Inherits:
Resource show all
Defined in:
lib/memori_client/engine/v2/memory.rb

Overview

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

Class Method Summary collapse

Methods inherited from Resource

build_url

Methods inherited from Resource

build_arguments, build_url, exec_http_request, validate_payload!

Class Method Details

.add_memory(strSessionID:, payload: {}) ⇒ Object

‘POST /memori/v2/Memory/strSessionID`

Adds a new Memory object.

‘add_memory(strSessionID:, payload: {})`

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.memoryID (String) —

    . optional

  • payload.memoryType (String) —

    . optional

  • payload.lastRead (String) —

    . optional

  • payload.readOccurrences (Integer) —

    . optional

  • payload.receiverID (String) —

    . optional

  • payload.receiverTag (String) —

    . optional

  • payload.receiverName (String) —

    . optional

  • payload.media (Array) —

    . optional

  • payload.title (String) —

    . optional

  • payload.titleVariants (Array) —

    . optional

  • payload.answers (Array) —

    . optional

  • payload.date (String) —

    . optional

  • payload.dateUncertaintyDays (Number) —

    . optional

  • payload.placeName (String) —

    . optional

  • payload.placeLatitude (Number) —

    . optional

  • payload.placeLongitude (Number) —

    . optional

  • payload.placeUncertaintyKm (Number) —

    . optional

  • payload.conclusive (Boolean) —

    . optional

  • payload.notPickable (Boolean) —

    . optional

  • payload.help (Boolean) —

    . optional

  • payload.hints (Array) —

    . optional

  • payload.minTimeout (Number) —

    . optional

  • payload.maxTimeout (Number) —

    . optional

  • payload.contextVarsToSet (Object) —

    . optional

  • payload.contextVarsToMatch (Object) —

    . optional

  • payload.dcmOutcomeType (String) —

    . optional

  • payload.dcmOutcomeCode (String) —

    . optional

  • payload.tags (Array) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.creationSessionID (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional

  • payload.lastChangeSessionID (String) —

    . optional



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/memori_client/engine/v2/memory.rb', line 418

def self.add_memory(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'answers',
    'conclusive',
    'contextVarsToMatch',
    'contextVarsToSet',
    'creationSessionID',
    'creationTimestamp',
    'date',
    'dateUncertaintyDays',
    'dcmOutcomeCode',
    'dcmOutcomeType',
    'help',
    'hints',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'lastRead',
    'maxTimeout',
    'media',
    'memoryID',
    'memoryType',
    'minTimeout',
    'notPickable',
    'placeLatitude',
    'placeLongitude',
    'placeName',
    'placeUncertaintyKm',
    'readOccurrences',
    'receiverID',
    'receiverName',
    'receiverTag',
    'tags',
    'title',
    'titleVariants',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/memori/v2/Memory/{strSessionID}', **args)
end

.check_memory_access(strSessionID:, strMemoryID:) ⇒ Object

‘GET /memori/v2/MemoryAccess/strSessionID/strMemoryID`

Checks if a Memory object is accessible from the specified session.

‘check_memory_access(strSessionID:, strMemoryID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strMemoryID (string) —

    The Memory object ID. required



470
471
472
473
474
 
# File 'lib/memori_client/engine/v2/memory.rb', line 470

def self.check_memory_access(strSessionID:, strMemoryID:)
  args = build_arguments(binding)

  exec_http_request('get', '/memori/v2/MemoryAccess/{strSessionID}/{strMemoryID}', **args)
end

.filter_memories(strSessionID:, payload: {}) ⇒ Object

‘POST /memori/v2/FilterMemories/strSessionID`

Filters Memory objects.

‘filter_memories(strSessionID:, payload: {})`

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.text (String) —

    . optional

  • payload.searchType (String) —

    . optional

  • payload.date (String) —

    . optional

  • payload.dateUncertaintyDays (Number) —

    . optional

  • payload.placeName (String) —

    . optional

  • payload.placeLatitude (Number) —

    . optional

  • payload.placeLongitude (Number) —

    . optional

  • payload.placeUncertaintyKm (Number) —

    . optional

  • payload.tag (String) —

    . optional

  • payload.ignoreLastRead (Boolean) —

    . optional

  • payload.excludedMemoryIDs (Array) —

    . optional

  • payload.contextVars (Object) —

    . optional

  • payload.contextVarsToSet (Object) —

    . optional

  • payload.memoryTags (Array) —

    . optional

  • payload.numberOfResults (Integer) —

    . optional

  • payload.startFrom (Integer) —

    . optional

  • payload.memoryType (String) —

    . optional

  • payload.withMediaOnly (Boolean) —

    . optional



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/memori_client/engine/v2/memory.rb', line 238

def self.filter_memories(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'contextVars',
    'contextVarsToSet',
    'date',
    'dateUncertaintyDays',
    'excludedMemoryIDs',
    'ignoreLastRead',
    'memoryTags',
    'memoryType',
    'numberOfResults',
    'placeLatitude',
    'placeLongitude',
    'placeName',
    'placeUncertaintyKm',
    'searchType',
    'startFrom',
    'tag',
    'text',
    'withMediaOnly',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/memori/v2/FilterMemories/{strSessionID}', **args)
end

.filter_memories_paginated(strSessionID:, from:, howMany:, payload: {}) ⇒ Object

‘POST /memori/v2/FilterMemories/strSessionID/from/howMany`

Filters Memory objects, with pagination.

‘filter_memories_paginated(strSessionID:, from:, howMany:, payload: {})`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • from (integer) —

    The 0-based index of the first Memory object to list. required

  • howMany (integer) —

    The number of the Memory objects to list. required

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

    request payload. optional

  • payload.text (String) —

    . optional

  • payload.searchType (String) —

    . optional

  • payload.date (String) —

    . optional

  • payload.dateUncertaintyDays (Number) —

    . optional

  • payload.placeName (String) —

    . optional

  • payload.placeLatitude (Number) —

    . optional

  • payload.placeLongitude (Number) —

    . optional

  • payload.placeUncertaintyKm (Number) —

    . optional

  • payload.tag (String) —

    . optional

  • payload.ignoreLastRead (Boolean) —

    . optional

  • payload.excludedMemoryIDs (Array) —

    . optional

  • payload.contextVars (Object) —

    . optional

  • payload.contextVarsToSet (Object) —

    . optional

  • payload.memoryTags (Array) —

    . optional

  • payload.numberOfResults (Integer) —

    . optional

  • payload.startFrom (Integer) —

    . optional

  • payload.memoryType (String) —

    . optional

  • payload.withMediaOnly (Boolean) —

    . optional



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/memori_client/engine/v2/memory.rb', line 316

def self.filter_memories_paginated(strSessionID:, from:, howMany:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'contextVars',
    'contextVarsToSet',
    'date',
    'dateUncertaintyDays',
    'excludedMemoryIDs',
    'ignoreLastRead',
    'memoryTags',
    'memoryType',
    'numberOfResults',
    'placeLatitude',
    'placeLongitude',
    'placeName',
    'placeUncertaintyKm',
    'searchType',
    'startFrom',
    'tag',
    'text',
    'withMediaOnly',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/memori/v2/FilterMemories/{strSessionID}/{from}/{howMany}', **args)
end

.get_memory(strSessionID:, strMemoryID:) ⇒ Object

‘GET /memori/v2/Memory/strSessionID/strMemoryID`

Gets the details of a Memory object.

‘get_memory(strSessionID:, strMemoryID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strMemoryID (string) —

    The Memory object ID. required



49
50
51
52
53
 
# File 'lib/memori_client/engine/v2/memory.rb', line 49

def self.get_memory(strSessionID:, strMemoryID:)
  args = build_arguments(binding)

  exec_http_request('get', '/memori/v2/Memory/{strSessionID}/{strMemoryID}', **args)
end

.list_memories(strSessionID:, type: nil) ⇒ Object

‘GET /memori/v2/Memories/strSessionID/type`

Lists all Memory objects.

‘list_memories(strSessionID:, type: nil)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • type (string) (defaults to: nil) —

    Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS, EXPERT_REFERENCES. optional



13
14
15
16
17
 
# File 'lib/memori_client/engine/v2/memory.rb', line 13

def self.list_memories(strSessionID:, type: nil)
  args = build_arguments(binding)

  exec_http_request('get', '/memori/v2/Memories/{strSessionID}/{type}', **args)
end

.list_memories_paginated(strSessionID:, from:, howMany:, type: nil) ⇒ Object

‘GET /memori/v2/Memories/strSessionID/from/howMany/type`

Lists Memory objects with pagination.

‘list_memories_paginated(strSessionID:, from:, howMany:, type: nil)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • from (integer) —

    The 0-based index of the first Memory object to list. required

  • howMany (integer) —

    The number of the Memory objects to list. required

  • type (string) (defaults to: nil) —

    Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS, EXPERT_REFERENCES. optional



33
34
35
36
37
 
# File 'lib/memori_client/engine/v2/memory.rb', line 33

def self.list_memories_paginated(strSessionID:, from:, howMany:, type: nil)
  args = build_arguments(binding)

  exec_http_request('get', '/memori/v2/Memories/{strSessionID}/{from}/{howMany}/{type}', **args)
end

.remove_memory(strSessionID:, strMemoryID:) ⇒ Object

‘DELETE /memori/v2/Memory/strSessionID/strMemoryID`

Removes an existing Memory object.

‘remove_memory(strSessionID:, strMemoryID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strMemoryID (string) —

    The Memory object ID. required



186
187
188
189
190
 
# File 'lib/memori_client/engine/v2/memory.rb', line 186

def self.remove_memory(strSessionID:, strMemoryID:)
  args = build_arguments(binding)

  exec_http_request('delete', '/memori/v2/Memory/{strSessionID}/{strMemoryID}', **args)
end

.update_memory(strSessionID:, strMemoryID:, payload: {}) ⇒ Object

‘PATCH /memori/v2/Memory/strSessionID/strMemoryID`

Updates an existing Memory object.

‘update_memory(strSessionID:, strMemoryID:, payload: {})`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strMemoryID (string) —

    The Memory object ID. required

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

    request payload. optional

  • payload.markAsRead (Boolean) —

    . optional

  • payload.memoryID (String) —

    . optional

  • payload.memoryType (String) —

    . optional

  • payload.lastRead (String) —

    . optional

  • payload.readOccurrences (Integer) —

    . optional

  • payload.receiverID (String) —

    . optional

  • payload.receiverTag (String) —

    . optional

  • payload.receiverName (String) —

    . optional

  • payload.media (Array) —

    . optional

  • payload.title (String) —

    . optional

  • payload.titleVariants (Array) —

    . optional

  • payload.answers (Array) —

    . optional

  • payload.date (String) —

    . optional

  • payload.dateUncertaintyDays (Number) —

    . optional

  • payload.placeName (String) —

    . optional

  • payload.placeLatitude (Number) —

    . optional

  • payload.placeLongitude (Number) —

    . optional

  • payload.placeUncertaintyKm (Number) —

    . optional

  • payload.conclusive (Boolean) —

    . optional

  • payload.notPickable (Boolean) —

    . optional

  • payload.help (Boolean) —

    . optional

  • payload.hints (Array) —

    . optional

  • payload.minTimeout (Number) —

    . optional

  • payload.maxTimeout (Number) —

    . optional

  • payload.contextVarsToSet (Object) —

    . optional

  • payload.contextVarsToMatch (Object) —

    . optional

  • payload.dcmOutcomeType (String) —

    . optional

  • payload.dcmOutcomeCode (String) —

    . optional

  • payload.tags (Array) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.creationSessionID (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional

  • payload.lastChangeSessionID (String) —

    . optional



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/memori_client/engine/v2/memory.rb', line 133

def self.update_memory(strSessionID:, strMemoryID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'answers',
    'conclusive',
    'contextVarsToMatch',
    'contextVarsToSet',
    'creationSessionID',
    'creationTimestamp',
    'date',
    'dateUncertaintyDays',
    'dcmOutcomeCode',
    'dcmOutcomeType',
    'help',
    'hints',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'lastRead',
    'markAsRead',
    'maxTimeout',
    'media',
    'memoryID',
    'memoryType',
    'minTimeout',
    'notPickable',
    'placeLatitude',
    'placeLongitude',
    'placeName',
    'placeUncertaintyKm',
    'readOccurrences',
    'receiverID',
    'receiverName',
    'receiverTag',
    'tags',
    'title',
    'titleVariants',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('patch', '/memori/v2/Memory/{strSessionID}/{strMemoryID}', **args)
end