Class: MemoriClient::Engine::V2::CorrelationPair

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

‘POST /memori/v2/CorrelationPair/strSessionID`

Adds a new Correlation Pair object.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.pairID (String) —

    . optional

  • payload.text1 (String) —

    . optional

  • payload.text2 (String) —

    . optional

  • payload.correlated (Boolean) —

    . optional

  • payload.occurrences (Integer) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.creationSessionID (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional

  • payload.lastChangeSessionID (String) —

    . optional



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/memori_client/engine/v2/correlation_pair.rb', line 63

def self.add_correlation_pair(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'correlated',
    'creationSessionID',
    'creationTimestamp',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'occurrences',
    'pairID',
    'text1',
    'text2',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

.list_correlation_pairs(strSessionID:) ⇒ Object

‘GET /memori/v2/CorrelationPairs/strSessionID`

Lists all Correlation Pair objects.

‘list_correlation_pairs(strSessionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required



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

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

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

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

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

Lists Correlation Pair objects with pagination.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

  • from (integer) —

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

  • howMany (integer) —

    The number of the Correlation Pair objects to list. required



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

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

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

.remove_correlation_pair(strSessionID:, strPairID:) ⇒ Object

‘DELETE /memori/v2/CorrelationPair/strSessionID/strPairID`

Removes an existing Correlation Pair object.

‘remove_correlation_pair(strSessionID:, strPairID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strPairID (string) —

    The Correlation Pair object ID. required



92
93
94
95
96
 
# File 'lib/memori_client/engine/v2/correlation_pair.rb', line 92

def self.remove_correlation_pair(strSessionID:, strPairID:)
  args = build_arguments(binding)

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