Class: MemoriClient::Engine::V2::Session

Inherits:
Resource show all
Defined in:
lib/memori_client/engine/v2/session.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

.close_session(strSessionID:) ⇒ Object

‘DELETE /memori/v2/Session/strSessionID`

Closes the session and disposes of its Dialog State Machine.

‘close_session(strSessionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required



73
74
75
76
77
 
# File 'lib/memori_client/engine/v2/session.rb', line 73

def self.close_session(strSessionID:)
  args = build_arguments(binding)

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

.get_current_state(strSessionID:) ⇒ Object

‘GET /memori/v2/Session/strSessionID`

Returns the current state of a session’s Dialog State Machine.

‘get_current_state(strSessionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required



59
60
61
62
63
 
# File 'lib/memori_client/engine/v2/session.rb', line 59

def self.get_current_state(strSessionID:)
  args = build_arguments(binding)

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

.open_session(payload: {}) ⇒ Object

‘POST /memori/v2/Session`

Initializes a new Dialog State Machine session for an existing Memori.

‘open_session(payload: {})`

Parameters:

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

    request payload. optional

  • payload.memoriID (String) —

    . optional

  • payload.password (String) —

    . optional

  • payload.recoveryTokens (Array) —

    . optional

  • payload.tag (String) —

    . optional

  • payload.pin (String) —

    . optional

  • payload.initialContextVars (Object) —

    . optional

  • payload.initialQuestion (String) —

    . optional

  • payload.birthDate (String) —

    . optional

  • payload.maintenanceCode (String) —

    . optional

  • payload.additionalInfo (Object) —

    . optional



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/memori_client/engine/v2/session.rb', line 31

def self.open_session(payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'additionalInfo',
    'birthDate',
    'initialContextVars',
    'initialQuestion',
    'maintenanceCode',
    'memoriID',
    'password',
    'pin',
    'recoveryTokens',
    'tag',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/memori/v2/Session', **args)
end