Class: Asana::Resources::PortfolioMembership

Inherits:
Resource
  • Object
show all
Defined in:
lib/asana/resources/portfolio_membership.rb

Overview

This object determines if a user is a member of a portfolio.

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Resource

inherited, #initialize, #method_missing, #refresh, #respond_to_missing?, #to_h, #to_s

Methods included from ResponseHelper

#parse

Constructor Details

This class inherits a constructor from Asana::Resources::Resource

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Asana::Resources::Resource

Instance Attribute Details

#gid ⇒ Object (readonly) 



12
13
14
 
# File 'lib/asana/resources/portfolio_membership.rb', line 12

def gid
  @gid
end

#id ⇒ Object (readonly) 



10
11
12
 
# File 'lib/asana/resources/portfolio_membership.rb', line 10

def id
  @id
end

#portfolio ⇒ Object (readonly) 



18
19
20
 
# File 'lib/asana/resources/portfolio_membership.rb', line 18

def portfolio
  @portfolio
end

#resource_type ⇒ Object (readonly) 



14
15
16
 
# File 'lib/asana/resources/portfolio_membership.rb', line 14

def resource_type
  @resource_type
end

#user ⇒ Object (readonly) 



16
17
18
 
# File 'lib/asana/resources/portfolio_membership.rb', line 16

def user
  @user
end

Class Method Details

.find_all(client, portfolio: nil, workspace: nil, user: nil, per_page: 20, options: {}) ⇒ Object

Returns the compact portfolio membership records for the portfolio. You must specify ‘portfolio`, `portfolio` and `user`, or `workspace` and `user`.

Parameters:

  • portfolio (Gid) (defaults to: nil) —

    The portfolio for which to fetch memberships.

  • workspace (Gid) (defaults to: nil) —

    The workspace for which to fetch memberships.

  • user (String) (defaults to: nil) —

    The user to filter the memberships to.

  • per_page (Integer) (defaults to: 20) —

    the number of records to fetch per page.

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

    the request I/O options.



34
35
36
37
 
# File 'lib/asana/resources/portfolio_membership.rb', line 34

def find_all(client, portfolio: nil, workspace: nil, user: nil, per_page: 20, options: {})
  params = { portfolio: portfolio, workspace: workspace, user: user, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
  Collection.new(parse(client.get("/portfolio_memberships", params: params, options: options)), type: Resource, client: client)
end

.find_by_id(client, id, options: {}) ⇒ Object

Returns the portfolio membership record.

Parameters:

  • id (Gid) —

    Globally unique identifier for the portfolio membership.

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

    the request I/O options.



55
56
57
58
 
# File 'lib/asana/resources/portfolio_membership.rb', line 55

def find_by_id(client, id, options: {})

  self.new(parse(client.get("/portfolio_memberships/#{id}", options: options)).first, client: client)
end

.find_by_portfolio(client, portfolio: required("portfolio"), user: nil, per_page: 20, options: {}) ⇒ Object

Returns the compact portfolio membership records for the portfolio.

Parameters:

  • portfolio (Gid) (defaults to: required("portfolio")) —

    The portfolio for which to fetch memberships.

  • user (String) (defaults to: nil) —

    If present, the user to filter the memberships to.

  • per_page (Integer) (defaults to: 20) —

    the number of records to fetch per page.

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

    the request I/O options.



45
46
47
48
 
# File 'lib/asana/resources/portfolio_membership.rb', line 45

def find_by_portfolio(client, portfolio: required("portfolio"), user: nil, per_page: 20, options: {})
  params = { user: user, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
  Collection.new(parse(client.get("/portfolios/#{portfolio}/portfolio_memberships", params: params, options: options)), type: Resource, client: client)
end

.plural_name ⇒ Object

Returns the plural name of the resource.



22
23
24
 
# File 'lib/asana/resources/portfolio_membership.rb', line 22

def plural_name
  'portfolio_memberships'
end