Class: MemoriClient::Engine::V2::Function

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

‘POST /memori/v2/Function/strSessionID`

Adds a new Function object.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.functionID (String) —

    . optional

  • payload.functionType (String) —

    . optional

  • payload.name (String) —

    . optional

  • payload.description (String) —

    . optional

  • payload.parameters (Array) —

    . optional

  • payload.webHook (String) —

    . optional

  • payload.httpMethod (String) —

    . optional

  • payload.httpHeaders (Object) —

    . optional

  • payload.httpQueryStringTemplate (String) —

    . optional

  • payload.httpBodyTemplate (String) —

    . optional

  • payload.httpBodyContentType (String) —

    . optional

  • payload.sendExtensionHeaders (Array) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.creationSessionID (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional

  • payload.lastChangeSessionID (String) —

    . optional



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/memori_client/engine/v2/function.rb', line 193

def self.add_function(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'creationSessionID',
    'creationTimestamp',
    'description',
    'functionID',
    'functionType',
    'httpBodyContentType',
    'httpBodyTemplate',
    'httpHeaders',
    'httpMethod',
    'httpQueryStringTemplate',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'name',
    'parameters',
    'sendExtensionHeaders',
    'webHook',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

.get_function(strSessionID:, strFunctionID:) ⇒ Object

‘GET /memori/v2/Function/strSessionID/strFunctionID`

Gets the details of a Function object.

‘get_function(strSessionID:, strFunctionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strFunctionID (string) —

    The Function object ID. required



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

def self.get_function(strSessionID:, strFunctionID:)
  args = build_arguments(binding)

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

.list_functions(strSessionID:) ⇒ Object

‘GET /memori/v2/Functions/strSessionID`

Lists all Function objects.

‘list_functions(strSessionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required



25
26
27
28
29
 
# File 'lib/memori_client/engine/v2/function.rb', line 25

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

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

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

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

Lists Function objects with pagination.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

  • from (integer) —

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

  • howMany (integer) —

    The number of the Function objects to list. required



43
44
45
46
47
 
# File 'lib/memori_client/engine/v2/function.rb', line 43

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

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

.list_macro_functions(strSessionID:) ⇒ Object

‘GET /memori/v2/MacroFunctions/strSessionID`

Lists all Macro Function objects.

‘list_macro_functions(strSessionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required



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

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

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

.remove_function(strSessionID:, strFunctionID:) ⇒ Object

‘DELETE /memori/v2/Function/strSessionID/strFunctionID`

Removes an existing Function object.

‘remove_function(strSessionID:, strFunctionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strFunctionID (string) —

    The Function object ID. required



145
146
147
148
149
 
# File 'lib/memori_client/engine/v2/function.rb', line 145

def self.remove_function(strSessionID:, strFunctionID:)
  args = build_arguments(binding)

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

.update_function(strSessionID:, strFunctionID:, payload: {}) ⇒ Object

‘PATCH /memori/v2/Function/strSessionID/strFunctionID`

Updates an existing Function object.

‘update_function(strSessionID:, strFunctionID:, payload: {})`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strFunctionID (string) —

    The Function object ID. required

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

    request payload. optional

  • payload.functionID (String) —

    . optional

  • payload.functionType (String) —

    . optional

  • payload.name (String) —

    . optional

  • payload.description (String) —

    . optional

  • payload.parameters (Array) —

    . optional

  • payload.webHook (String) —

    . optional

  • payload.httpMethod (String) —

    . optional

  • payload.httpHeaders (Object) —

    . optional

  • payload.httpQueryStringTemplate (String) —

    . optional

  • payload.httpBodyTemplate (String) —

    . optional

  • payload.httpBodyContentType (String) —

    . optional

  • payload.sendExtensionHeaders (Array) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.creationSessionID (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional

  • payload.lastChangeSessionID (String) —

    . optional



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/memori_client/engine/v2/function.rb', line 109

def self.update_function(strSessionID:, strFunctionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'creationSessionID',
    'creationTimestamp',
    'description',
    'functionID',
    'functionType',
    'httpBodyContentType',
    'httpBodyTemplate',
    'httpHeaders',
    'httpMethod',
    'httpQueryStringTemplate',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'name',
    'parameters',
    'sendExtensionHeaders',
    'webHook',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('patch', '/memori/v2/Function/{strSessionID}/{strFunctionID}', **args)
end