Class: MemoriClient::Engine::V2::ExpertReference

Inherits:
Resource show all
Defined in:
lib/memori_client/engine/v2/expert_reference.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_expert_reference(strSessionID:, payload: {}) ⇒ Object

‘POST /memori/v2/ExpertReference/strSessionID`

Adds a new Expert Reference object.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.expertID (String) —

    . optional

  • payload.name (String) —

    . optional

  • payload.description (String) —

    . optional

  • payload.default (Boolean) —

    . optional

  • payload.expertMemoriID (String) —

    . optional

  • payload.expertPassword (String) —

    . optional

  • payload.expertBaseURL (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.creationSessionID (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional

  • payload.lastChangeSessionID (String) —

    . optional



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/memori_client/engine/v2/expert_reference.rb', line 154

def self.add_expert_reference(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'creationSessionID',
    'creationTimestamp',
    'default',
    'description',
    'expertBaseURL',
    'expertID',
    'expertMemoriID',
    'expertPassword',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'name',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

.get_expert_reference(strSessionID:, strExpertReferenceID:) ⇒ Object

‘GET /memori/v2/ExpertReference/strSessionID/strExpertReferenceID`

Gets the details of an Expert Reference object.

‘get_expert_reference(strSessionID:, strExpertReferenceID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strExpertReferenceID (string) —

    The Expert Reference object ID. required



45
46
47
48
49
 
# File 'lib/memori_client/engine/v2/expert_reference.rb', line 45

def self.get_expert_reference(strSessionID:, strExpertReferenceID:)
  args = build_arguments(binding)

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

.list_expert_references(strSessionID:) ⇒ Object

‘GET /memori/v2/ExpertReferences/strSessionID`

Lists all Expert Reference objects.

‘list_expert_references(strSessionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required



11
12
13
14
15
 
# File 'lib/memori_client/engine/v2/expert_reference.rb', line 11

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

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

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

‘GET /memori/v2/ExpertReferences/strSessionID/from/howMany`

Lists Expert Reference objects with pagination.

‘list_expert_references_paginated(strSessionID:, from:, howMany:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • from (integer) —

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

  • howMany (integer) —

    The number of the Expert Reference objects to list. required



29
30
31
32
33
 
# File 'lib/memori_client/engine/v2/expert_reference.rb', line 29

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

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

.remove_expert_reference(strSessionID:, strExpertReferenceID:) ⇒ Object

‘DELETE /memori/v2/ExpertReference/strSessionID/strExpertReferenceID`

Removes an existing Expert Reference object.

‘remove_expert_reference(strSessionID:, strExpertReferenceID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strExpertReferenceID (string) —

    The Expert Reference object ID. required



116
117
118
119
120
 
# File 'lib/memori_client/engine/v2/expert_reference.rb', line 116

def self.remove_expert_reference(strSessionID:, strExpertReferenceID:)
  args = build_arguments(binding)

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

.update_expert_reference(strSessionID:, strExpertReferenceID:, payload: {}) ⇒ Object

‘PATCH /memori/v2/ExpertReference/strSessionID/strExpertReferenceID`

Updates an existing Expert Reference object.

‘update_expert_reference(strSessionID:, strExpertReferenceID:, payload: {})`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strExpertReferenceID (string) —

    The Expert Reference object ID. required

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

    request payload. optional

  • payload.expertID (String) —

    . optional

  • payload.name (String) —

    . optional

  • payload.description (String) —

    . optional

  • payload.default (Boolean) —

    . optional

  • payload.expertMemoriID (String) —

    . optional

  • payload.expertPassword (String) —

    . optional

  • payload.expertBaseURL (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.creationSessionID (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional

  • payload.lastChangeSessionID (String) —

    . optional



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/memori_client/engine/v2/expert_reference.rb', line 85

def self.update_expert_reference(strSessionID:, strExpertReferenceID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'creationSessionID',
    'creationTimestamp',
    'default',
    'description',
    'expertBaseURL',
    'expertID',
    'expertMemoriID',
    'expertPassword',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'name',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('patch', '/memori/v2/ExpertReference/{strSessionID}/{strExpertReferenceID}', **args)
end