Class: Asana::Resources::GoalRelationshipsBase

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

Direct Known Subclasses

GoalRelationship

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_supporting_relationship(client, goal_gid: required("goal_gid"), options: {}, **data) ⇒ Object

Add a supporting goal relationship

Parameters:

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

    (required) Globally unique identifier for the goal.

  • 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/goal_relationships_base.rb', line 22

def add_supporting_relationship(client, goal_gid: required("goal_gid"), options: {}, **data)
  path = "/goals/{goal_gid}/addSupportingRelationship"
  path["{goal_gid}"] = goal_gid
  parse(client.post(path, body: data, options: options)).first
end

.get_goal_relationship(client, goal_relationship_gid: required("goal_relationship_gid"), options: {}) ⇒ Object

Get a goal relationship

Parameters:

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

    (required) Globally unique identifier for the goal relationship.

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



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

def get_goal_relationship(client, goal_relationship_gid: required("goal_relationship_gid"), options: {})
  path = "/goal_relationships/{goal_relationship_gid}"
  path["{goal_relationship_gid}"] = goal_relationship_gid
  parse(client.get(path, options: options)).first
end

.get_goal_relationships(client, supported_goal: nil, resource_subtype: nil, options: {}) ⇒ Object

supported_goal - [str] (required) Globally unique identifier for the supported goal in the goal relationship.

Parameters:

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

    If provided, filter to goal relationships with a given resource_subtype.

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



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

def get_goal_relationships(client, supported_goal: nil, resource_subtype: nil, options: {})
  path = "/goal_relationships"
  params = { supported_goal: supported_goal, resource_subtype: resource_subtype }.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/goal_relationships_base.rb', line 10

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

.remove_supporting_relationship(client, goal_gid: required("goal_gid"), options: {}, **data) ⇒ Object

Removes a supporting goal relationship

Parameters:

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

    (required) Globally unique identifier for the goal.

  • 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



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

def remove_supporting_relationship(client, goal_gid: required("goal_gid"), options: {}, **data)
  path = "/goals/{goal_gid}/removeSupportingRelationship"
  path["{goal_gid}"] = goal_gid
  parse(client.post(path, body: data, options: options)).first
end

.update_goal_relationship(client, goal_relationship_gid: required("goal_relationship_gid"), options: {}, **data) ⇒ Object

Update a goal relationship

Parameters:

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

    (required) Globally unique identifier for the goal relationship.

  • 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



74
75
76
77
78
 
# File 'lib/asana/resources/gen/goal_relationships_base.rb', line 74

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