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

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

Overview

Generated on 2023-10-20 07:44:40 +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 an new Localization Key. Params list: add_localization_key(strSessionID:, payload: {})



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

def self.add_localization_key(strSessionID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'creationSessionID',
    'creationTimestamp',
    'key',
    'lastChangeSessionID',
    'lastChangeTimestamp',
    'value',
  ]
  payload_required_keys = %w[value]
  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. Params list: get_localization_key(strSessionID:, strKey:)



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

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. Params list: list_localization_keys(strSessionID:)



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

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. Params list: list_localization_keys_paginated(strSessionID:, from:, howMany:)



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

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. Params list: remove_localization_key(strSessionID:, strKey:)



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

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. Params list: update_localization_key(strSessionID:, payload: {})



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

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

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