Class: MemoriClient::Engine::V2::Dialog

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

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

‘POST /memori/v2/DateChangedEvent/strSessionID`

Submits a Date Changed event to the session’s Dialog State Machine.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.date (String) —

    . optional



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/memori_client/engine/v2/dialog.rb', line 38

def self.change_date(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'date',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

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

‘POST /memori/v2/PlaceChangedEvent/strSessionID`

Submits a Place Changed event to the session’s Dialog State Machine.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.placeName (String) —

    . optional

  • payload.latitude (Number) —

    . optional

  • payload.longitude (Number) —

    . optional

  • payload.uncertaintyKm (Number) —

    . optional



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/memori_client/engine/v2/dialog.rb', line 67

def self.change_place(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'latitude',
    'longitude',
    'placeName',
    'uncertaintyKm',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

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

‘POST /memori/v2/TagChangedEvent/strSessionID`

Submits a Tag Changed event to the session’s Dialog State Machine.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.tag (String) —

    . optional



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/memori_client/engine/v2/dialog.rb', line 93

def self.change_tag(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'tag',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

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

‘POST /memori/v2/TextEnteredEvent/strSessionID`

Submits a Text Entered event to the session’s Dialog State Machine.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.text (String) —

    . optional



15
16
17
18
19
20
21
22
23
24
 
# File 'lib/memori_client/engine/v2/dialog.rb', line 15

def self.enter_text(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'text',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

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

‘POST /memori/v2/DateSelectedEvent/strSessionID`

Submits a Date Selected event to the session’s Dialog State Machine.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.date (String) —

    . optional

  • payload.uncertaintyDays (Number) —

    . optional



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/memori_client/engine/v2/dialog.rb', line 155

def self.select_date(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'date',
    'uncertaintyDays',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

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

‘POST /memori/v2/MediumSelectedEvent/strSessionID`

Submits a Medium Selected event to the session’s Dialog State Machine.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • [] —

    payload.medium . optional



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/memori_client/engine/v2/dialog.rb', line 130

def self.select_medium(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'medium',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

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

‘POST /memori/v2/PlaceSelectedEvent/strSessionID`

Submits a Place Selected event to the session’s Dialog State Machine.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.placeName (String) —

    . optional

  • payload.latitude (Number) —

    . optional

  • payload.longitude (Number) —

    . optional

  • payload.uncertaintyKm (Number) —

    . optional



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/memori_client/engine/v2/dialog.rb', line 185

def self.select_place(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'latitude',
    'longitude',
    'placeName',
    'uncertaintyKm',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

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

‘POST /memori/v2/TagSelectedEvent/strSessionID`

Submits a Tag Selected event to the session’s Dialog State Machine.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.tag (String) —

    . optional



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/memori_client/engine/v2/dialog.rb', line 211

def self.select_tag(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'tag',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

.timeout(strSessionID:) ⇒ Object

‘POST /memori/v2/TimeoutEvent/strSessionID`

Submits a Timeout event to the session’s Dialog State Machine.

‘timeout(strSessionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required



112
113
114
115
116
 
# File 'lib/memori_client/engine/v2/dialog.rb', line 112

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

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