Module: RubyLokaliseApi::Rest::Projects

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

Instance Method Summary collapse

Instance Method Details

#create_project(params) ⇒ RubyLokaliseApi::Resources::Project

Creates project

Parameters:

  • params (Hash)

Returns:

See Also:



29
30
31
 
# File 'lib/ruby_lokalise_api/rest/projects.rb', line 29

def create_project(params)
  c_r RubyLokaliseApi::Resources::Project, :create, nil, params
end

#destroy_project(project_id) ⇒ Hash

Deletes the project

Parameters:

  • project_id (String, Integer)

Returns:

  • (Hash)

See Also:



57
58
59
 
# File 'lib/ruby_lokalise_api/rest/projects.rb', line 57

def destroy_project(project_id)
  c_r RubyLokaliseApi::Resources::Project, :destroy, project_id
end

#empty_project(project_id) ⇒ Hash

Deletes all keys and translations from the project

Parameters:

  • project_id (String, Integer)

Returns:

  • (Hash)

See Also:



48
49
50
 
# File 'lib/ruby_lokalise_api/rest/projects.rb', line 48

def empty_project(project_id)
  c_r RubyLokaliseApi::Resources::Project, :empty, [project_id, 'empty']
end

#project(project_id) ⇒ RubyLokaliseApi::Resources::Project

Returns a single project

Parameters:

  • project_id (String, Integer)

Returns:

See Also:



20
21
22
 
# File 'lib/ruby_lokalise_api/rest/projects.rb', line 20

def project(project_id)
  c_r RubyLokaliseApi::Resources::Project, :find, project_id
end

#projects(params = {}) ⇒ RubyLokaliseApi::Collection::Project<RubyLokaliseApi::Resources::Project>

Returns all projects available to the user authorized with the API token

Parameters:

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

Returns:

See Also:



11
12
13
 
# File 'lib/ruby_lokalise_api/rest/projects.rb', line 11

def projects(params = {})
  c_r RubyLokaliseApi::Collections::Project, :all, nil, params
end

#update_project(project_id, params) ⇒ RubyLokaliseApi::Resources::Project

Updates project

Parameters:

  • project_id (String, Integer)
  • params (Hash)

Returns:

See Also:



39
40
41
 
# File 'lib/ruby_lokalise_api/rest/projects.rb', line 39

def update_project(project_id, params)
  c_r RubyLokaliseApi::Resources::Project, :update, project_id, params
end