Class: MemoriClient::Engine::V2::LocalizationKey

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

‘POST /memori/v2/LocalizationKey/strSessionID`

Add a new Localization Key.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.key (String) —

    . optional

  • payload.value (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.creationSessionID (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional

  • payload.lastChangeSessionID (String) —

    . optional



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/memori_client/engine/v2/localization_key.rb', line 89

def self.add_localization_key(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'creationSessionID',
    'creationTimestamp',
    'key',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'value',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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

.get_localization_key(strSessionID:, strKey:) ⇒ Object

‘GET /memori/v2/LocalizationKey/strSessionID/strKey`

Get an existing Localization Key.

‘get_localization_key(strSessionID:, strKey:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strKey (string) —

    The key of the Localization Key. required



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

def self.get_localization_key(strSessionID:, strKey:)
  args = build_arguments(binding)

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

.list_localization_keys(strSessionID:) ⇒ Object

‘GET /memori/v2/LocalizationKeys/strSessionID`

Lists all Localization Keys.

‘list_localization_keys(strSessionID:)`

Parameters:

  • strSessionID (string) —

    The session ID. required



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

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

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

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

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

Lists Localization Keys with pagination.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

  • from (integer) —

    The 0-based index of the first Localization Key to list. required

  • howMany (integer) —

    The number of the Localization Keys to list. required



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

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

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

.remove_localization_key(strSessionID:, strKey:) ⇒ Object

‘DELETE /memori/v2/LocalizationKey/strSessionID/strKey`

Removes an existing Localization Key.

‘remove_localization_key(strSessionID:, strKey:)`

Parameters:

  • strSessionID (string) —

    The session ID. required

  • strKey (string) —

    The key of the Localization Key. required



61
62
63
64
65
 
# File 'lib/memori_client/engine/v2/localization_key.rb', line 61

def self.remove_localization_key(strSessionID:, strKey:)
  args = build_arguments(binding)

  exec_http_request('delete', '/memori/v2/LocalizationKey/{strSessionID}/{strKey}', **args)
end

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

‘PATCH /memori/v2/LocalizationKey/strSessionID`

Updates an existing Localization Key.

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

Parameters:

  • strSessionID (string) —

    The session ID. required

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

    request payload. optional

  • payload.key (String) —

    . optional

  • payload.value (String) —

    . optional

  • payload.creationTimestamp (String) —

    . optional

  • payload.creationSessionID (String) —

    . optional

  • payload.lastChangeTimestamp (String) —

    . optional

  • payload.lastChangeSessionID (String) —

    . optional



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/memori_client/engine/v2/localization_key.rb', line 127

def self.update_localization_key(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'creationSessionID',
    'creationTimestamp',
    'key',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'value',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

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