Module: RubyLokaliseApi::Rest::Keys

Included in:
Client
Defined in:
lib/ruby_lokalise_api/rest/keys.rb

Instance Method Summary collapse

Instance Method Details

#create_keys(project_id, params = {}) ⇒ RubyLokaliseApi::Collection::Key<RubyLokaliseApi::Resources::Key>

Creates one or more translation keys for the given project

Parameters:

  • project_id (String)
  • params (Hash, Array<Hash>) (defaults to: {})

Returns:

See Also:



33
34
35
 
# File 'lib/ruby_lokalise_api/rest/keys.rb', line 33

def create_keys(project_id, params = {})
  c_r RubyLokaliseApi::Resources::Key, :create, project_id, params, :keys
end

#destroy_key(project_id, key_id) ⇒ Hash

Deletes translation key for the given project

Parameters:

  • project_id (String)
  • key_id (String, Integer)

Returns:

  • (Hash)

See Also:



64
65
66
 
# File 'lib/ruby_lokalise_api/rest/keys.rb', line 64

def destroy_key(project_id, key_id)
  c_r RubyLokaliseApi::Resources::Key, :destroy, [project_id, key_id]
end

#destroy_keys(project_id, key_ids) ⇒ Hash

Deletes one or multiple translation keys for the given project

Parameters:

  • project_id (String)
  • key_ids (String, Integer, Array<String>, Array<Integer>)

Returns:

  • (Hash)

See Also:



74
75
76
 
# File 'lib/ruby_lokalise_api/rest/keys.rb', line 74

def destroy_keys(project_id, key_ids)
  c_r RubyLokaliseApi::Resources::Key, :destroy, project_id, key_ids, :keys
end

#key(project_id, key_id, params = {}) ⇒ RubyLokaliseApi::Resources::Key

Returns a single translation key for the given project

Parameters:

  • project_id (String)
  • key_id (String, Integer)
  • params (Hash) (defaults to: {})

Returns:

See Also:



23
24
25
 
# File 'lib/ruby_lokalise_api/rest/keys.rb', line 23

def key(project_id, key_id, params = {})
  c_r RubyLokaliseApi::Resources::Key, :find, [project_id, key_id], params
end

#keys(project_id, params = {}) ⇒ RubyLokaliseApi::Collection::Key<RubyLokaliseApi::Resources::Key>

Returns all translation keys for the given project

Parameters:

  • project_id (String)
  • params (Hash) (defaults to: {})

Returns:

See Also:



12
13
14
 
# File 'lib/ruby_lokalise_api/rest/keys.rb', line 12

def keys(project_id, params = {})
  c_r RubyLokaliseApi::Collections::Key, :all, project_id, params
end

#update_key(project_id, key_id, params = {}) ⇒ RubyLokaliseApi::Resources::Key

Updates translation key for the given project

Parameters:

  • project_id (String)
  • key_id (String, Integer)
  • params (Hash) (defaults to: {})

Returns:

See Also:



44
45
46
 
# File 'lib/ruby_lokalise_api/rest/keys.rb', line 44

def update_key(project_id, key_id, params = {})
  c_r RubyLokaliseApi::Resources::Key, :update, [project_id, key_id], params
end

#update_keys(project_id, params) ⇒ RubyLokaliseApi::Collection::Key<RubyLokaliseApi::Resources::Key>

Updates one or multiple translation keys for the given project

Parameters:

  • project_id (String)
  • params (Hash, Array<Hash>)

Returns:

See Also:



54
55
56
 
# File 'lib/ruby_lokalise_api/rest/keys.rb', line 54

def update_keys(project_id, params)
  c_r RubyLokaliseApi::Resources::Key, :update, project_id, params, :keys
end