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

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

Add a subgoal to a parent 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


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

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

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

Add a project/portfolio as supporting work for 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


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

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


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

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


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

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.


87
88
89
90
91
# File 'lib/asana/resources/gen/goals_base.rb', line 87

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.


99
100
101
102
103
# File 'lib/asana/resources/gen/goals_base.rb', line 99

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.


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

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.


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

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

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

Get subgoals 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.


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

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


156
157
158
159
160
# File 'lib/asana/resources/gen/goals_base.rb', line 156

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

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

Remove a subgoal 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


169
170
171
172
173
# File 'lib/asana/resources/gen/goals_base.rb', line 169

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

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

Remove a project/portfolio as supporting work for 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


182
183
184
185
186
# File 'lib/asana/resources/gen/goals_base.rb', line 182

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

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

Get supporting work 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.


194
195
196
197
198
# File 'lib/asana/resources/gen/goals_base.rb', line 194

def supporting_work(client, goal_gid: required("goal_gid"), options: {})
  path = "/goals/{goal_gid}/supportingWork"
  path["{goal_gid}"] = goal_gid
  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


207
208
209
210
211
# File 'lib/asana/resources/gen/goals_base.rb', line 207

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


220
221
222
223
224
# File 'lib/asana/resources/gen/goals_base.rb', line 220

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