class Asana::Resources::SectionsBase

Public Class Methods

add_task_for_section(client, section_gid: required("section_gid"), options: {}, **data) click to toggle source

Add task to section

section_gid - [str] (required) The globally unique identifier for the section. 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. data - [Hash] the attributes to POST

# File lib/asana/resources/gen/sections_base.rb, line 22
def add_task_for_section(client, section_gid: required("section_gid"), options: {}, **data)
  path = "/sections/{section_gid}/addTask"
  path["{section_gid}"] = section_gid
  parse(client.post(path, body: data, options: options)).first
end
create_section_for_project(client, project_gid: required("project_gid"), options: {}, **data) click to toggle source

Create a section in a project

project_gid - [str] (required) Globally unique identifier for the project. 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. data - [Hash] the attributes to POST

# File lib/asana/resources/gen/sections_base.rb, line 35
def create_section_for_project(client, project_gid: required("project_gid"), options: {}, **data)
  path = "/projects/{project_gid}/sections"
  path["{project_gid}"] = project_gid
  Section.new(parse(client.post(path, body: data, options: options)).first, client: client)
end
delete_section(client, section_gid: required("section_gid"), options: {}) click to toggle source

Delete a section

section_gid - [str] (required) The globally unique identifier for the section. 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.

# File lib/asana/resources/gen/sections_base.rb, line 47
def delete_section(client, section_gid: required("section_gid"), options: {})
  path = "/sections/{section_gid}"
  path["{section_gid}"] = section_gid
  parse(client.delete(path, options: options)).first
end
get_section(client, section_gid: required("section_gid"), options: {}) click to toggle source

Get a section

section_gid - [str] (required) The globally unique identifier for the section. 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.

# File lib/asana/resources/gen/sections_base.rb, line 59
def get_section(client, section_gid: required("section_gid"), options: {})
  path = "/sections/{section_gid}"
  path["{section_gid}"] = section_gid
  Section.new(parse(client.get(path, options: options)).first, client: client)
end
get_sections_for_project(client, project_gid: required("project_gid"), options: {}) click to toggle source

Get sections in a project

project_gid - [str] (required) Globally unique identifier for the project. 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.

# File lib/asana/resources/gen/sections_base.rb, line 73
def get_sections_for_project(client, project_gid: required("project_gid"), options: {})
  path = "/projects/{project_gid}/sections"
  path["{project_gid}"] = project_gid
  Collection.new(parse(client.get(path, options: options)), type: Section, client: client)
end
inherited(base) click to toggle source
# File lib/asana/resources/gen/sections_base.rb, line 10
def self.inherited(base)
  Registry.register(base)
end
insert_section_for_project(client, project_gid: required("project_gid"), options: {}, **data) click to toggle source

Move or Insert sections

project_gid - [str] (required) Globally unique identifier for the project. 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. data - [Hash] the attributes to POST

# File lib/asana/resources/gen/sections_base.rb, line 86
def insert_section_for_project(client, project_gid: required("project_gid"), options: {}, **data)
  path = "/projects/{project_gid}/sections/insert"
  path["{project_gid}"] = project_gid
  parse(client.post(path, body: data, options: options)).first
end
update_section(client, section_gid: required("section_gid"), options: {}, **data) click to toggle source

Update a section

section_gid - [str] (required) The globally unique identifier for the section. 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. data - [Hash] the attributes to PUT

# File lib/asana/resources/gen/sections_base.rb, line 99
def update_section(client, section_gid: required("section_gid"), options: {}, **data)
  path = "/sections/{section_gid}"
  path["{section_gid}"] = section_gid
  Section.new(parse(client.put(path, body: data, options: options)).first, client: client)
end