class Asana::Resources::StoriesBase

Public Class Methods

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

Create a story on a task

task_gid - [str] (required) The task to operate on. 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/stories_base.rb, line 22
def create_story_for_task(client, task_gid: required("task_gid"), options: {}, **data)
  path = "/tasks/{task_gid}/stories"
  path["{task_gid}"] = task_gid
  Story.new(parse(client.post(path, body: data, options: options)).first, client: client)
end
delete_story(client, story_gid: required("story_gid"), options: {}) click to toggle source

Delete a story

story_gid - [str] (required) Globally unique identifier for the story. 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/stories_base.rb, line 34
def delete_story(client, story_gid: required("story_gid"), options: {})
  path = "/stories/{story_gid}"
  path["{story_gid}"] = story_gid
  parse(client.delete(path, options: options)).first
end
get_stories_for_task(client, task_gid: required("task_gid"), options: {}) click to toggle source

Get stories from a task

task_gid - [str] (required) The task to operate on. 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/stories_base.rb, line 48
def get_stories_for_task(client, task_gid: required("task_gid"), options: {})
  path = "/tasks/{task_gid}/stories"
  path["{task_gid}"] = task_gid
  Collection.new(parse(client.get(path, options: options)), type: Story, client: client)
end
get_story(client, story_gid: required("story_gid"), options: {}) click to toggle source

Get a story

story_gid - [str] (required) Globally unique identifier for the story. 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/stories_base.rb, line 62
def get_story(client, story_gid: required("story_gid"), options: {})
  path = "/stories/{story_gid}"
  path["{story_gid}"] = story_gid
  Story.new(parse(client.get(path, options: options)).first, client: client)
end
inherited(base) click to toggle source
# File lib/asana/resources/gen/stories_base.rb, line 10
def self.inherited(base)
  Registry.register(base)
end
update_story(client, story_gid: required("story_gid"), options: {}, **data) click to toggle source

Update a story

story_gid - [str] (required) Globally unique identifier for the story. 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/stories_base.rb, line 75
def update_story(client, story_gid: required("story_gid"), options: {}, **data)
  path = "/stories/{story_gid}"
  path["{story_gid}"] = story_gid
  Story.new(parse(client.put(path, body: data, options: options)).first, client: client)
end