class Asana::Resources::TeamMembershipsBase

Public Class Methods

get_team_membership(client, team_membership_gid: required("team_membership_gid"), options: {}) click to toggle source

Get a team membership

team_membership_gid - [str] (required) options - [Hash] the request I/O options > 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.

# File lib/asana/resources/gen/team_memberships_base.rb, line 21
def get_team_membership(client, team_membership_gid: required("team_membership_gid"), options: {})
  path = "/team_memberships/{team_membership_gid}"
  path["{team_membership_gid}"] = team_membership_gid
  parse(client.get(path, options: options)).first
end
get_team_memberships(client, team: nil, user: nil, workspace: nil, options: {}) click to toggle source

team - [str] Globally unique identifier for the team. user - [str] A string identifying a user. This can either be the string "me", an email, or the gid of a user. This parameter must be used with the workspace parameter. workspace - [str] Globally unique identifier for the workspace. This parameter must be used with the user parameter. 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.

# File lib/asana/resources/gen/team_memberships_base.rb, line 38
def get_team_memberships(client, team: nil, user: nil, workspace: nil, options: {})
  path = "/team_memberships"
  params = { team: team, user: user, workspace: workspace }.reject { |_,v| v.nil? || Array(v).empty? }
  Collection.new(parse(client.get(path, params: params, options: options)), type: Resource, client: client)
end
get_team_memberships_for_team(client, team_gid: required("team_gid"), options: {}) click to toggle source

Get memberships from a team

team_gid - [str] (required) Globally unique identifier for the team. 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.

# File lib/asana/resources/gen/team_memberships_base.rb, line 52
def get_team_memberships_for_team(client, team_gid: required("team_gid"), options: {})
  path = "/teams/{team_gid}/team_memberships"
  path["{team_gid}"] = team_gid
  Collection.new(parse(client.get(path, options: options)), type: Resource, client: client)
end
get_team_memberships_for_user(client, user_gid: required("user_gid"), workspace: nil, options: {}) click to toggle source

Get memberships from a user

user_gid - [str] (required) A string identifying a user. This can either be the string "me", an email, or the gid of a user. workspace - [str] (required) Globally unique identifier for the workspace. 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.

# File lib/asana/resources/gen/team_memberships_base.rb, line 67
def get_team_memberships_for_user(client, user_gid: required("user_gid"), workspace: nil, options: {})
  path = "/users/{user_gid}/team_memberships"
  path["{user_gid}"] = user_gid
  params = { workspace: workspace }.reject { |_,v| v.nil? || Array(v).empty? }
  Collection.new(parse(client.get(path, params: params, options: options)), type: Resource, client: client)
end
inherited(base) click to toggle source
# File lib/asana/resources/gen/team_memberships_base.rb, line 10
def self.inherited(base)
  Registry.register(base)
end