Class: Asana::Resources::Project
- Includes:
- EventSubscription
- Defined in:
- lib/asana/resources/project.rb
Overview
A project represents a prioritized list of tasks in Asana. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
Projects in organizations are shared with a single team. You cannot currently change the team of a project via the API. Non-organization workspaces do not have teams and so you should not specify the team of project in a regular workspace.
Instance Attribute Summary collapse
- #archived ⇒ Object readonly
- #color ⇒ Object readonly
- #created_at ⇒ Object readonly
- #current_status ⇒ Object readonly
- #custom_field_settings ⇒ Object readonly
- #due_date ⇒ Object readonly
- #followers ⇒ Object readonly
- #id ⇒ Object readonly
- #members ⇒ Object readonly
- #modified_at ⇒ Object readonly
- #name ⇒ Object readonly
- #notes ⇒ Object readonly
- #owner ⇒ Object readonly
- #public ⇒ Object readonly
- #team ⇒ Object readonly
- #workspace ⇒ Object readonly
Class Method Summary collapse
-
.create(client, workspace: required("workspace"), team: nil, options: {}, **data) ⇒ Object
Creates a new project in a workspace or team.
-
.create_in_team(client, team: required("team"), options: {}, **data) ⇒ Object
Creates a project shared with the given team.
-
.create_in_workspace(client, workspace: required("workspace"), options: {}, **data) ⇒ Object
If the workspace for your project is an organization, you must also supply a ‘team` to share the project with.
-
.find_all(client, workspace: nil, team: nil, archived: nil, per_page: 20, options: {}) ⇒ Object
Returns the compact project records for some filtered set of projects.
-
.find_by_id(client, id, options: {}) ⇒ Object
Returns the complete project record for a single project.
-
.find_by_team(client, team: required("team"), archived: nil, per_page: 20, options: {}) ⇒ Object
Returns the compact project records for all projects in the team.
-
.find_by_workspace(client, workspace: required("workspace"), archived: nil, per_page: 20, options: {}) ⇒ Object
Returns the compact project records for all projects in the workspace.
-
.plural_name ⇒ Object
Returns the plural name of the resource.
Instance Method Summary collapse
-
#add_custom_field_setting(custom_field: required("custom_field"), is_important: nil, insert_before: nil, insert_after: nil, options: {}, **data) ⇒ Object
Create a new custom field setting on the project.
-
#add_followers(followers: required("followers"), options: {}, **data) ⇒ Object
Adds the specified list of users as followers to the project.
-
#add_members(members: required("members"), options: {}, **data) ⇒ Object
Adds the specified list of users as members of the project.
-
#delete ⇒ Object
A specific, existing project can be deleted by making a DELETE request on the URL for that project.
-
#remove_custom_field_setting(custom_field: nil, options: {}, **data) ⇒ Object
Remove a custom field setting on the project.
-
#remove_followers(followers: required("followers"), options: {}, **data) ⇒ Object
Removes the specified list of users from following the project, this will not affect project membership status.
-
#remove_members(members: required("members"), options: {}, **data) ⇒ Object
Removes the specified list of members from the project.
-
#sections(per_page: 20, options: {}) ⇒ Object
Returns compact records for all sections in the specified project.
-
#tasks(per_page: 20, options: {}) ⇒ Object
Returns the compact task records for all tasks within the given project, ordered by their priority within the project.
-
#update(options: {}, **data) ⇒ Object
A specific, existing project can be updated by making a PUT request on the URL for that project.
Methods included from EventSubscription
Methods inherited from Resource
inherited, #initialize, #method_missing, #refresh, #respond_to_missing?, #to_h, #to_s
Methods included from ResponseHelper
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
Instance Attribute Details
#archived ⇒ Object (readonly)
33 34 35 |
# File 'lib/asana/resources/project.rb', line 33 def archived @archived end |
#color ⇒ Object (readonly)
43 44 45 |
# File 'lib/asana/resources/project.rb', line 43 def color @color end |
#created_at ⇒ Object (readonly)
29 30 31 |
# File 'lib/asana/resources/project.rb', line 29 def created_at @created_at end |
#current_status ⇒ Object (readonly)
25 26 27 |
# File 'lib/asana/resources/project.rb', line 25 def current_status @current_status end |
#custom_field_settings ⇒ Object (readonly)
41 42 43 |
# File 'lib/asana/resources/project.rb', line 41 def custom_field_settings @custom_field_settings end |
#due_date ⇒ Object (readonly)
27 28 29 |
# File 'lib/asana/resources/project.rb', line 27 def due_date @due_date end |
#followers ⇒ Object (readonly)
39 40 41 |
# File 'lib/asana/resources/project.rb', line 39 def followers @followers end |
#id ⇒ Object (readonly)
21 22 23 |
# File 'lib/asana/resources/project.rb', line 21 def id @id end |
#members ⇒ Object (readonly)
37 38 39 |
# File 'lib/asana/resources/project.rb', line 37 def members @members end |
#modified_at ⇒ Object (readonly)
31 32 33 |
# File 'lib/asana/resources/project.rb', line 31 def modified_at @modified_at end |
#name ⇒ Object (readonly)
19 20 21 |
# File 'lib/asana/resources/project.rb', line 19 def name @name end |
#notes ⇒ Object (readonly)
45 46 47 |
# File 'lib/asana/resources/project.rb', line 45 def notes @notes end |
#owner ⇒ Object (readonly)
23 24 25 |
# File 'lib/asana/resources/project.rb', line 23 def owner @owner end |
#public ⇒ Object (readonly)
35 36 37 |
# File 'lib/asana/resources/project.rb', line 35 def public @public end |
#team ⇒ Object (readonly)
49 50 51 |
# File 'lib/asana/resources/project.rb', line 49 def team @team end |
#workspace ⇒ Object (readonly)
47 48 49 |
# File 'lib/asana/resources/project.rb', line 47 def workspace @workspace end |
Class Method Details
.create(client, workspace: required("workspace"), team: nil, options: {}, **data) ⇒ Object
Creates a new project in a workspace or team.
Every project is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the ‘workspace` parameter regardless of whether or not it is an organization.
If the workspace for your project is an organization, you must also supply a ‘team` to share the project with.
75 76 77 78 |
# File 'lib/asana/resources/project.rb', line 75 def create(client, workspace: required("workspace"), team: nil, options: {}, **data) with_params = data.merge(workspace: workspace, team: team).reject { |_,v| v.nil? || Array(v).empty? } self.new(parse(client.post("/projects", body: with_params, options: )).first, client: client) end |
.create_in_team(client, team: required("team"), options: {}, **data) ⇒ Object
Creates a project shared with the given team.
100 101 102 103 |
# File 'lib/asana/resources/project.rb', line 100 def create_in_team(client, team: required("team"), options: {}, **data) self.new(parse(client.post("/teams/#{team}/projects", body: data, options: )).first, client: client) end |
.create_in_workspace(client, workspace: required("workspace"), options: {}, **data) ⇒ Object
If the workspace for your project is an organization, you must also supply a ‘team` to share the project with.
88 89 90 91 |
# File 'lib/asana/resources/project.rb', line 88 def create_in_workspace(client, workspace: required("workspace"), options: {}, **data) self.new(parse(client.post("/workspaces/#{workspace}/projects", body: data, options: )).first, client: client) end |
.find_all(client, workspace: nil, team: nil, archived: nil, per_page: 20, options: {}) ⇒ Object
Returns the compact project records for some filtered set of projects. Use one or more of the parameters provided to filter the projects returned.
124 125 126 127 |
# File 'lib/asana/resources/project.rb', line 124 def find_all(client, workspace: nil, team: nil, archived: nil, per_page: 20, options: {}) params = { workspace: workspace, team: team, archived: archived, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? } Collection.new(parse(client.get("/projects", params: params, options: )), type: self, client: client) end |
.find_by_id(client, id, options: {}) ⇒ Object
Returns the complete project record for a single project.
109 110 111 112 |
# File 'lib/asana/resources/project.rb', line 109 def find_by_id(client, id, options: {}) self.new(parse(client.get("/projects/#{id}", options: )).first, client: client) end |
.find_by_team(client, team: required("team"), archived: nil, per_page: 20, options: {}) ⇒ Object
Returns the compact project records for all projects in the team.
150 151 152 153 |
# File 'lib/asana/resources/project.rb', line 150 def find_by_team(client, team: required("team"), archived: nil, per_page: 20, options: {}) params = { archived: archived, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? } Collection.new(parse(client.get("/teams/#{team}/projects", params: params, options: )), type: self, client: client) end |
.find_by_workspace(client, workspace: required("workspace"), archived: nil, per_page: 20, options: {}) ⇒ Object
Returns the compact project records for all projects in the workspace.
137 138 139 140 |
# File 'lib/asana/resources/project.rb', line 137 def find_by_workspace(client, workspace: required("workspace"), archived: nil, per_page: 20, options: {}) params = { archived: archived, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? } Collection.new(parse(client.get("/workspaces/#{workspace}/projects", params: params, options: )), type: self, client: client) end |
.plural_name ⇒ Object
Returns the plural name of the resource.
53 54 55 |
# File 'lib/asana/resources/project.rb', line 53 def plural_name 'projects' end |
Instance Method Details
#add_custom_field_setting(custom_field: required("custom_field"), is_important: nil, insert_before: nil, insert_after: nil, options: {}, **data) ⇒ Object
Create a new custom field setting on the project.
257 258 259 260 |
# File 'lib/asana/resources/project.rb', line 257 def add_custom_field_setting(custom_field: required("custom_field"), is_important: nil, insert_before: nil, insert_after: nil, options: {}, **data) with_params = data.merge(custom_field: custom_field, is_important: is_important, insert_before: insert_before, insert_after: insert_after).reject { |_,v| v.nil? || Array(v).empty? } Resource.new(parse(client.post("/projects/#{id}/addCustomFieldSetting", body: with_params, options: )).first, client: client) end |
#add_followers(followers: required("followers"), options: {}, **data) ⇒ Object
Adds the specified list of users as followers to the project. Followers are a subset of members, therefore if the users are not already members of the project they will also become members as a result of this operation.
208 209 210 211 |
# File 'lib/asana/resources/project.rb', line 208 def add_followers(followers: required("followers"), options: {}, **data) with_params = data.merge(followers: followers).reject { |_,v| v.nil? || Array(v).empty? } refresh_with(parse(client.post("/projects/#{id}/addFollowers", body: with_params, options: )).first) end |
#add_members(members: required("members"), options: {}, **data) ⇒ Object
Adds the specified list of users as members of the project. Returns the updated project record.
229 230 231 232 |
# File 'lib/asana/resources/project.rb', line 229 def add_members(members: required("members"), options: {}, **data) with_params = data.merge(members: members).reject { |_,v| v.nil? || Array(v).empty? } refresh_with(parse(client.post("/projects/#{id}/addMembers", body: with_params, options: )).first) end |
#delete ⇒ Object
A specific, existing project can be deleted by making a DELETE request on the URL for that project.
177 178 179 180 |
# File 'lib/asana/resources/project.rb', line 177 def delete() client.delete("/projects/#{id}") && true end |
#remove_custom_field_setting(custom_field: nil, options: {}, **data) ⇒ Object
Remove a custom field setting on the project.
267 268 269 270 |
# File 'lib/asana/resources/project.rb', line 267 def remove_custom_field_setting(custom_field: nil, options: {}, **data) with_params = data.merge(custom_field: custom_field).reject { |_,v| v.nil? || Array(v).empty? } Resource.new(parse(client.post("/projects/#{id}/removeCustomFieldSetting", body: with_params, options: )).first, client: client) end |
#remove_followers(followers: required("followers"), options: {}, **data) ⇒ Object
Removes the specified list of users from following the project, this will not affect project membership status.
219 220 221 222 |
# File 'lib/asana/resources/project.rb', line 219 def remove_followers(followers: required("followers"), options: {}, **data) with_params = data.merge(followers: followers).reject { |_,v| v.nil? || Array(v).empty? } refresh_with(parse(client.post("/projects/#{id}/removeFollowers", body: with_params, options: )).first) end |
#remove_members(members: required("members"), options: {}, **data) ⇒ Object
Removes the specified list of members from the project. Returns the updated project record.
239 240 241 242 |
# File 'lib/asana/resources/project.rb', line 239 def remove_members(members: required("members"), options: {}, **data) with_params = data.merge(members: members).reject { |_,v| v.nil? || Array(v).empty? } refresh_with(parse(client.post("/projects/#{id}/removeMembers", body: with_params, options: )).first) end |
#sections(per_page: 20, options: {}) ⇒ Object
Returns compact records for all sections in the specified project.
186 187 188 189 |
# File 'lib/asana/resources/project.rb', line 186 def sections(per_page: 20, options: {}) params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? } Collection.new(parse(client.get("/projects/#{id}/sections", params: params, options: )), type: Resource, client: client) end |
#tasks(per_page: 20, options: {}) ⇒ Object
Returns the compact task records for all tasks within the given project, ordered by their priority within the project. Tasks can exist in more than one project at a time.
196 197 198 199 |
# File 'lib/asana/resources/project.rb', line 196 def tasks(per_page: 20, options: {}) params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? } Collection.new(parse(client.get("/projects/#{id}/tasks", params: params, options: )), type: Task, client: client) end |
#update(options: {}, **data) ⇒ Object
A specific, existing project can be updated by making a PUT request on the URL for that project. Only the fields provided in the ‘data` block will be updated; any unspecified fields will remain unchanged.
When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task.
168 169 170 171 |
# File 'lib/asana/resources/project.rb', line 168 def update(options: {}, **data) refresh_with(parse(client.put("/projects/#{id}", body: data, options: )).first) end |