Module: RubyLokaliseApi::Rest::Contributors

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

Instance Method Summary collapse

Instance Method Details

#contributor(project_id, contributor_id) ⇒ RubyLokaliseApi::Resources::Contributor

Returns a single contributor for the given project

Parameters:

  • project_id (String)
  • contributor_id (String, Integer)

Returns:

See Also:



22
23
24
 
# File 'lib/ruby_lokalise_api/rest/contributors.rb', line 22

def contributor(project_id, contributor_id)
  c_r RubyLokaliseApi::Resources::Contributor, :find, [project_id, contributor_id]
end

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

Returns all contributors for the given project

Parameters:

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

Returns:

See Also:



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

def contributors(project_id, params = {})
  c_r RubyLokaliseApi::Collections::Contributor, :all, project_id, params
end

#create_contributors(project_id, params) ⇒ RubyLokaliseApi::Collection::Contributor<RubyLokaliseApi::Resources::Contributor>

Creates one or more contributors inside the given project

Parameters:

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

Returns:

See Also:



32
33
34
 
# File 'lib/ruby_lokalise_api/rest/contributors.rb', line 32

def create_contributors(project_id, params)
  c_r RubyLokaliseApi::Resources::Contributor, :create, project_id, params, :contributors
end

#destroy_contributor(project_id, contributor_id) ⇒ Hash

Deletes contributor inside the given project

Parameters:

  • project_id (String)
  • contributor_id (String, Integer)

Returns:

  • (Hash)

See Also:



53
54
55
 
# File 'lib/ruby_lokalise_api/rest/contributors.rb', line 53

def destroy_contributor(project_id, contributor_id)
  c_r RubyLokaliseApi::Resources::Contributor, :destroy, [project_id, contributor_id]
end

#update_contributor(project_id, contributor_id, params) ⇒ RubyLokaliseApi::Resources::Contributor

Updates the given contributor inside the given project

Parameters:

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

Returns:

See Also:



43
44
45
 
# File 'lib/ruby_lokalise_api/rest/contributors.rb', line 43

def update_contributor(project_id, contributor_id, params)
  c_r RubyLokaliseApi::Resources::Contributor, :update, [project_id, contributor_id], params
end