Module: BWAPI::Client::Projects::Sharing

Included in:
BWAPI::Client::Projects
Defined in:
lib/bwapi/client/projects/sharing.rb

Overview

Sharing module for projects/sharing endpoints

Instance Method Summary collapse

Instance Method Details

#default_project_sharing ⇒ Hashie::Mash

Default shares of a project

Returns:

  • (Hashie::Mash) —

    Default project shares information



11
12
13
 
# File 'lib/bwapi/client/projects/sharing.rb', line 11

def default_project_sharing
  get 'projects/sharing'
end

#project_sharing(project_id, opts = {}) ⇒ Hashie::Mash

Shares of a project

Parameters:

  • project_id (Integer) —

    Id of project

  • opts (Hash) (defaults to: {}) —

    options hash of parameters

Returns:

  • (Hashie::Mash) —

    Specific project shares



21
22
23
 
# File 'lib/bwapi/client/projects/sharing.rb', line 21

def project_sharing(project_id, opts = {})
  get "projects/#{project_id}/sharing", opts
end

#project_sharing_user(project_id, user_id) ⇒ Hashie::Mash

User share of a project

Parameters:

  • project_id (Integer) —

    Id of project

  • user_id (Integer) —

    Id of user

Returns:

  • (Hashie::Mash) —

    Share of project for user



40
41
42
 
# File 'lib/bwapi/client/projects/sharing.rb', line 40

def project_sharing_user(project_id, user_id)
  get "projects/#{project_id}/sharing/#{user_id}"
end

#update_project_sharing(project_id, opts = {}) ⇒ Hashie::Mash

Update shares of a project

Parameters:

  • project_id (Integer) —

    Id of project

  • opts (Hash) (defaults to: {}) —

    options hash of parameters

Returns:

  • (Hashie::Mash) —

    Updated project shares



31
32
33
 
# File 'lib/bwapi/client/projects/sharing.rb', line 31

def update_project_sharing(project_id, opts = {})
  put "projects/#{project_id}/sharing", opts
end

#update_project_sharing_user(project_id, user_id, opts = {}) ⇒ Hashie::Mash

Edit user share of a project

Parameters:

  • project_id (Integer) —

    Id of project

  • user_id (Integer) —

    Id of user

Returns:

  • (Hashie::Mash) —

    Updated share of project for user



50
51
52
 
# File 'lib/bwapi/client/projects/sharing.rb', line 50

def update_project_sharing_user(project_id, user_id, opts = {})
  put "projects/#{project_id}/sharing/#{user_id}", opts
end