Class: Asana::Resources::GoalsBase

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

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

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

.add_subgoal(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



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

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

.add_supporting_work_for_goal(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



46
47
48
49
 
# File 'lib/asana/resources/gen/goals_base.rb', line 46

def add_supporting_work_for_goal(client, options: {}, **data)
  path = "/goals/{goal_gid}/addSupportingWork"
  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



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

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

.create_goal_metric(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



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

def create_goal_metric(client, options: {}, **data)
  path = "/goals/{goal_gid}/setMetric"
  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.



83
84
85
86
87
 
# File 'lib/asana/resources/gen/goals_base.rb', line 83

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.



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

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.



115
116
117
118
119
 
# File 'lib/asana/resources/gen/goals_base.rb', line 115

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, options: {}) ⇒ 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.



127
128
129
130
 
# File 'lib/asana/resources/gen/goals_base.rb', line 127

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

.get_subgoals_for_goal(client, options: {}) ⇒ 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.



138
139
140
141
 
# File 'lib/asana/resources/gen/goals_base.rb', line 138

def get_subgoals_for_goal(client, options: {})
  path = "/goals/{goal_gid}/subgoals"
  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, 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



150
151
152
153
 
# File 'lib/asana/resources/gen/goals_base.rb', line 150

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

.remove_subgoal(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



162
163
164
165
 
# File 'lib/asana/resources/gen/goals_base.rb', line 162

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

.remove_supporting_work_for_goal(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



174
175
176
177
 
# File 'lib/asana/resources/gen/goals_base.rb', line 174

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

.supporting_work(client, options: {}) ⇒ 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.



185
186
187
188
 
# File 'lib/asana/resources/gen/goals_base.rb', line 185

def supporting_work(client, options: {})
  path = "/goals/{goal_gid}/supportingWork"
  Collection.new(parse(client.get(path, options: options)), type: Project, client: client)
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



197
198
199
200
201
 
# File 'lib/asana/resources/gen/goals_base.rb', line 197

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, 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



210
211
212
213
 
# File 'lib/asana/resources/gen/goals_base.rb', line 210

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