Class: Asana::Resources::MembershipsBase

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

Direct Known Subclasses

Membership

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

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

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.

Parameters:

  • data (Hash) —

    the attributes to POST



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

def create_membership(client, options: {}, **data)
  path = "/memberships"
  parse(client.post(path, body: data, options: options)).first
end

.delete_membership(client, membership_gid: required("membership_gid"), options: {}) ⇒ Object

Delete a membership

Parameters:

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

    (required) Globally unique identifier for the membership.

  • 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.



33
34
35
36
37
 
# File 'lib/asana/resources/gen/memberships_base.rb', line 33

def delete_membership(client, membership_gid: required("membership_gid"), options: {})
  path = "/memberships/{membership_gid}"
  path["{membership_gid}"] = membership_gid
  parse(client.delete(path, options: options)).first
end

.get_memberships(client, parent: nil, member: nil, options: {}) ⇒ Object

parent - [str] (required) Globally unique identifier for ‘project`, `portfolio`, `team`, `goal`, and `workspace`.

Parameters:

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

    Globally unique identifier for ‘team` and `user`.

  • 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] Pagination limit for the request.

  • 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.



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

def get_memberships(client, parent: nil, member: nil, options: {})
  path = "/memberships"
  params = { parent: parent, member: member }.reject { |_,v| v.nil? || Array(v).empty? }
  Collection.new(parse(client.get(path, params: params, options: options)), type: Resource, client: client)
end

.inherited(base) ⇒ Object 



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

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

.update_membership(client, membership_gid: required("membership_gid"), options: {}, **data) ⇒ Object

Update a membership

Parameters:

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

    (required) Globally unique identifier for the membership.

  • 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 PUT



62
63
64
65
66
 
# File 'lib/asana/resources/gen/memberships_base.rb', line 62

def update_membership(client, membership_gid: required("membership_gid"), options: {}, **data)
  path = "/memberships/{membership_gid}"
  path["{membership_gid}"] = membership_gid
  parse(client.put(path, body: data, options: options)).first
end