Class: Asana::Resources::TeamsBase

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

Direct Known Subclasses

Team

Class Method Summary collapse

Methods inherited from Resource

#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

Class Method Details

.add_user_for_team(client, team_gid: required("team_gid"), options: {}, **data) ⇒ Object

Add a user to a team

Parameters:

  • team_gid (str) (defaults to: required("team_gid")) —

    (required) Globally unique identifier for the team.

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

    the request I/O options

  • list (>str) —

    ] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.

  • bool (>]) —

    opt_pretty [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

  • data (Hash) —

    the attributes to POST



22
23
24
25
26
 
# File 'lib/asana/resources/gen/teams_base.rb', line 22

def add_user_for_team(client, team_gid: required("team_gid"), options: {}, **data)
  path = "/teams/{team_gid}/addUser"
  path["{team_gid}"] = team_gid
  parse(client.post(path, body: data, options: options)).first
end

.create_team(client, options: {}, **data) ⇒ Object

options - [Hash] the request I/O options > offset - [str] Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. ‘Note: You can only pass in an offset that was returned to you via a previously paginated request.’ > limit - [int] Results per page. The number of objects to return per page. The value must be between 1 and 100. > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

Parameters:

  • data (Hash) —

    the attributes to POST



37
38
39
40
 
# File 'lib/asana/resources/gen/teams_base.rb', line 37

def create_team(client, options: {}, **data)
  path = "/teams"
  Team.new(parse(client.post(path, body: data, options: options)).first, client: client)
end

.get_team(client, team_gid: required("team_gid"), options: {}) ⇒ Object

Get a team

Parameters:

  • team_gid (str) (defaults to: required("team_gid")) —

    (required) Globally unique identifier for the team.

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

    the request I/O options

  • str (>]'Note: You can only pass in an offset that was returned to you via a previously paginated request.') —

    offset [str] Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. ‘Note: You can only pass in an offset that was returned to you via a previously paginated request.’

  • int (>]) —

    limit [int] Results per page. The number of objects to return per page. The value must be between 1 and 100.

  • list (>str) —

    ] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.

  • bool (>]) —

    opt_pretty [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.



50
51
52
53
54
 
# File 'lib/asana/resources/gen/teams_base.rb', line 50

def get_team(client, team_gid: required("team_gid"), options: {})
  path = "/teams/{team_gid}"
  path["{team_gid}"] = team_gid
  Team.new(parse(client.get(path, options: options)).first, client: client)
end

.get_teams_for_user(client, user_gid: required("user_gid"), organization: nil, options: {}) ⇒ Object

Get teams for a user

Parameters:

  • user_gid (str) (defaults to: required("user_gid")) —

    (required) A string identifying a user. This can either be the string "me", an email, or the gid of a user.

  • organization (str) (defaults to: nil) —

    (required) The workspace or organization to filter teams on.

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

    the request I/O options

  • str (>]'Note: You can only pass in an offset that was returned to you via a previously paginated request.') —

    offset [str] Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. ‘Note: You can only pass in an offset that was returned to you via a previously paginated request.’

  • int (>]) —

    limit [int] Results per page. The number of objects to return per page. The value must be between 1 and 100.

  • list (>str) —

    ] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.

  • bool (>]) —

    opt_pretty [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.



65
66
67
68
69
70
 
# File 'lib/asana/resources/gen/teams_base.rb', line 65

def get_teams_for_user(client, user_gid: required("user_gid"), organization: nil, options: {})
  path = "/users/{user_gid}/teams"
  path["{user_gid}"] = user_gid
  params = { organization: organization }.reject { |_,v| v.nil? || Array(v).empty? }
  Collection.new(parse(client.get(path, params: params, options: options)), type: Team, client: client)
end

.get_teams_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}) ⇒ Object

Get teams in a workspace

Parameters:

  • workspace_gid (str) (defaults to: required("workspace_gid")) —

    (required) Globally unique identifier for the workspace or organization.

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

    the request I/O options

  • str (>]'Note: You can only pass in an offset that was returned to you via a previously paginated request.') —

    offset [str] Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. ‘Note: You can only pass in an offset that was returned to you via a previously paginated request.’

  • int (>]) —

    limit [int] Results per page. The number of objects to return per page. The value must be between 1 and 100.

  • list (>str) —

    ] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.

  • bool (>]) —

    opt_pretty [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.



80
81
82
83
84
 
# File 'lib/asana/resources/gen/teams_base.rb', line 80

def get_teams_for_workspace(client, workspace_gid: required("workspace_gid"), options: {})
  path = "/workspaces/{workspace_gid}/teams"
  path["{workspace_gid}"] = workspace_gid
  Collection.new(parse(client.get(path, options: options)), type: Team, client: client)
end

.inherited(base) ⇒ Object 



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

def self.inherited(base)
  Registry.register(base)
end

.remove_user_for_team(client, team_gid: required("team_gid"), options: {}, **data) ⇒ Object

Remove a user from a team

Parameters:

  • team_gid (str) (defaults to: required("team_gid")) —

    (required) Globally unique identifier for the team.

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

    the request I/O options

  • list (>str) —

    ] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.

  • bool (>]) —

    opt_pretty [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

  • data (Hash) —

    the attributes to POST



93
94
95
96
97
 
# File 'lib/asana/resources/gen/teams_base.rb', line 93

def remove_user_for_team(client, team_gid: required("team_gid"), options: {}, **data)
  path = "/teams/{team_gid}/removeUser"
  path["{team_gid}"] = team_gid
  parse(client.post(path, body: data, options: options)).first
end

.update_team(client, options: {}, **data) ⇒ Object

options - [Hash] the request I/O options > offset - [str] Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. ‘Note: You can only pass in an offset that was returned to you via a previously paginated request.’ > limit - [int] Results per page. The number of objects to return per page. The value must be between 1 and 100. > opt_fields - [list] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. > opt_pretty - [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

Parameters:

  • data (Hash) —

    the attributes to PUT



108
109
110
111
 
# File 'lib/asana/resources/gen/teams_base.rb', line 108

def update_team(client, options: {}, **data)
  path = "/teams"
  Team.new(parse(client.put(path, body: data, options: options)).first, client: client)
end