Class: Asana::Resources::GoalsBase

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

Direct Known Subclasses

Goal

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

Add a collaborator to a goal

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

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

.create_goal(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/goals_base.rb', line 37

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

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

Create a goal metric

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



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

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

.delete_goal(client, goal_gid: required("goal_gid"), options: {}) ⇒ Object

Delete a goal

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.



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

def delete_goal(client, goal_gid: required("goal_gid"), options: {})
  path = "/goals/{goal_gid}"
  path["{goal_gid}"] = goal_gid
  parse(client.delete(path, options: options)).first
end

.get_goal(client, goal_gid: required("goal_gid"), options: {}) ⇒ Object

Get a goal

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.



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

def get_goal(client, goal_gid: required("goal_gid"), options: {})
  path = "/goals/{goal_gid}"
  path["{goal_gid}"] = goal_gid
  parse(client.get(path, options: options)).first
end

.get_goals(client, portfolio: nil, project: nil, is_workspace_level: nil, team: nil, workspace: nil, time_periods: nil, options: {}) ⇒ Object

portfolio - [str] Globally unique identifier for supporting portfolio.

Parameters:

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

    Globally unique identifier for supporting project.

  • is_workspace_level (bool) (defaults to: nil) —

    Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter.

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

    Globally unique identifier for the team.

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

    Globally unique identifier for the workspace.

  • time_periods (list[str]) (defaults to: nil) —

    Globally unique identifiers for the time periods.

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



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

def get_goals(client, portfolio: nil, project: nil, is_workspace_level: nil, team: nil, workspace: nil, time_periods: nil, options: {})
  path = "/goals"
  params = { portfolio: portfolio, project: project, is_workspace_level: is_workspace_level, team: team, workspace: workspace, time_periods: time_periods }.reject { |_,v| v.nil? || Array(v).empty? }
  Collection.new(parse(client.get(path, params: params, options: options)), type: Resource, client: client)
end

.get_parent_goals_for_goal(client, goal_gid: required("goal_gid"), options: {}) ⇒ Object

Get parent goals from a goal

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.



105
106
107
108
109
 
# File 'lib/asana/resources/gen/goals_base.rb', line 105

def get_parent_goals_for_goal(client, goal_gid: required("goal_gid"), options: {})
  path = "/goals/{goal_gid}/parentGoals"
  path["{goal_gid}"] = goal_gid
  Collection.new(parse(client.get(path, options: options)), type: Resource, client: client)
end

.inherited(base) ⇒ Object 



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

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

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

Remove a collaborator from a goal

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



118
119
120
121
122
 
# File 'lib/asana/resources/gen/goals_base.rb', line 118

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

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

Update a goal

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 PUT



131
132
133
134
135
 
# File 'lib/asana/resources/gen/goals_base.rb', line 131

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

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

Update a goal metric

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



144
145
146
147
148
 
# File 'lib/asana/resources/gen/goals_base.rb', line 144

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