Module: RubyLokaliseApi::Rest::Branches

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

Instance Method Summary collapse

Instance Method Details

#branch(project_id, branch_id) ⇒ RubyLokaliseApi::Resources::Branch

Returns a single branch for the given project

Parameters:

  • project_id (String)
  • branch_id (String, Integer)

Returns:

See Also:



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

def branch(project_id, branch_id)
  c_r RubyLokaliseApi::Resources::Branch, :find, [project_id, branch_id]
end

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

Returns all branches for the given project

Parameters:

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

Returns:

See Also:



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

def branches(project_id, params = {})
  c_r RubyLokaliseApi::Collections::Branch, :all, project_id, params
end

#create_branch(project_id, params) ⇒ RubyLokaliseApi::Resources::Branch

Creates a new branch inside the given project

Parameters:

  • project_id (String)
  • params (Hash)

Returns:

See Also:



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

def create_branch(project_id, params)
  c_r RubyLokaliseApi::Resources::Branch, :create, project_id, params
end

#destroy_branch(project_id, branch_id) ⇒ Hash

Deletes branch inside the given project

Parameters:

  • project_id (String)
  • branch_id (String, Integer)

Returns:

  • (Hash)

See Also:



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

def destroy_branch(project_id, branch_id)
  c_r RubyLokaliseApi::Resources::Branch, :destroy, [project_id, branch_id]
end

#merge_branch(project_id, branch_id, params = {}) ⇒ Hash

Merges a branch in the project

Parameters:

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

Returns:

  • (Hash)

See Also:



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

def merge_branch(project_id, branch_id, params = {})
  c_r RubyLokaliseApi::Resources::Branch, :merge, [project_id, branch_id, :merge], params
end

#update_branch(project_id, branch_id, params) ⇒ RubyLokaliseApi::Resources::Branch

Updates the given branch inside the given project

Parameters:

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

Returns:

See Also:



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

def update_branch(project_id, branch_id, params)
  c_r RubyLokaliseApi::Resources::Branch, :update, [project_id, branch_id], params
end