Class: MemoriClient::Engine::V2::PromptedQuestion

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

Overview

Generated on 2024-01-18 17:37:07 +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_prompted_question(strSessionID:, payload: {}) ⇒ Object

POST /memori/v2/PromptedQuestion/strSessionID Adds a new Prompted Question object. Params list: add_prompted_question(strSessionID:, payload: {})

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.promptedQuestionID (string) —

    . optional

  • payload.promptType (string) —

    . required

  • payload.prompt (string) —

    . required

  • payload.questionTitle (string) —

    . optional

  • payload.storyTitle (string) —

    . optional

  • payload.creationTimestamp (string) —

    . optional

  • payload.creationSessionID (string) —

    . optional

  • payload.lastChangeTimestamp (string) —

    . optional

  • payload.lastChangeSessionID (string) —

    . optional



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/memori_client/engine/v2/prompted_question.rb', line 101

def self.add_prompted_question(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'creationSessionID',
    'creationTimestamp',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'prompt',
    'promptType',
    'promptedQuestionID',
    'questionTitle',
    'storyTitle',
  ]
  payload_required_keys = %w[prompt promptType]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

.get_prompted_question(strSessionID:, strPromptID:) ⇒ Object

GET /memori/v2/PromptedQuestion/strSessionID/strPromptID Gets the details of a Prompted Question object. Params list: get_prompted_question(strSessionID:, strPromptID:)

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strPromptID (string) —

    The Prompted Question object ID. required



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

def self.get_prompted_question(strSessionID:, strPromptID:)
  args = build_arguments(binding)

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

.list_prompted_questions(strSessionID:) ⇒ Object

GET /memori/v2/PromptedQuestions/strSessionID Lists all Prompted Question objects. Params list: list_prompted_questions(strSessionID:)

Parameters:

  • strSessionID (string) —

    The session ID. required



8
9
10
11
12
 
# File 'lib/memori_client/engine/v2/prompted_question.rb', line 8

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

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

.list_prompted_questions_paginated(strSessionID:, from:, howMany:) ⇒ Object

GET /memori/v2/PromptedQuestions/strSessionID/from/howMany Lists Prompted Question objects with pagination. Params list: list_prompted_questions_paginated(strSessionID:, from:, howMany:)

Parameters:

  • strSessionID (string) —

    The session ID. required

  • from (integer) —

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

  • howMany (integer) —

    The number of the Prompted Question objects to list. required



21
22
23
24
25
 
# File 'lib/memori_client/engine/v2/prompted_question.rb', line 21

def self.list_prompted_questions_paginated(strSessionID:, from:, howMany:)
  args = build_arguments(binding)

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

.remove_prompted_question(strSessionID:, strPromptID:) ⇒ Object

DELETE /memori/v2/PromptedQuestion/strSessionID/strPromptID Removes an existing Prompted Question object. Params list: remove_prompted_question(strSessionID:, strPromptID:)

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strPromptID (string) —

    The Prompted Question object ID. required



80
81
82
83
84
 
# File 'lib/memori_client/engine/v2/prompted_question.rb', line 80

def self.remove_prompted_question(strSessionID:, strPromptID:)
  args = build_arguments(binding)

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

.update_prompted_question(strSessionID:, strPromptID:, payload: {}) ⇒ Object

PATCH /memori/v2/PromptedQuestion/strSessionID/strPromptID Updates an existing Prompted Question object. Params list: update_prompted_question(strSessionID:, strPromptID:, payload: {})

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strPromptID (string) —

    The Prompted Question object ID. required

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

    request payload. optional

  • payload.promptedQuestionID (string) —

    . optional

  • payload.promptType (string) —

    . required

  • payload.prompt (string) —

    . required

  • payload.questionTitle (string) —

    . optional

  • payload.storyTitle (string) —

    . optional

  • payload.creationTimestamp (string) —

    . optional

  • payload.creationSessionID (string) —

    . optional

  • payload.lastChangeTimestamp (string) —

    . optional

  • payload.lastChangeSessionID (string) —

    . optional



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/memori_client/engine/v2/prompted_question.rb', line 55

def self.update_prompted_question(strSessionID:, strPromptID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'creationSessionID',
    'creationTimestamp',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'prompt',
    'promptType',
    'promptedQuestionID',
    'questionTitle',
    'storyTitle',
  ]
  payload_required_keys = %w[prompt promptType]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('patch', '/memori/v2/PromptedQuestion/{strSessionID}/{strPromptID}', **args)
end