Class: Asana::Resources::StoriesBase

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

Direct Known Subclasses

Story

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

.create_story_for_task(client, task_gid: required("task_gid"), options: {}, **data) ⇒ Object

Create a story on a task

Parameters:

  • task_gid (str) (defaults to: required("task_gid")) —

    (required) The task to operate on.

  • 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/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: {}) ⇒ Object

Delete a story

Parameters:

  • story_gid (str) (defaults to: required("story_gid")) —

    (required) Globally unique identifier for the story.

  • 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.



34
35
36
37
38
 
# 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: {}) ⇒ Object

Get stories from a task

Parameters:

  • task_gid (str) (defaults to: required("task_gid")) —

    (required) The task to operate on.

  • 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.



48
49
50
51
52
 
# 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: {}) ⇒ Object

Get a story

Parameters:

  • story_gid (str) (defaults to: required("story_gid")) —

    (required) Globally unique identifier for the story.

  • 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.



62
63
64
65
66
 
# 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) ⇒ Object 



10
11
12
 
# 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) ⇒ Object

Update a story

Parameters:

  • story_gid (str) (defaults to: required("story_gid")) —

    (required) Globally unique identifier for the story.

  • 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



75
76
77
78
79
 
# 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