Class: Asana::Resources::ProjectBriefsBase

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

Direct Known Subclasses

ProjectBrief

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_project_brief(client, project_gid: required("project_gid"), options: {}, **data) ⇒ Object

Create a project brief

Parameters:

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

    (required) Globally unique identifier for the project.

  • 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/project_briefs_base.rb', line 22

def create_project_brief(client, project_gid: required("project_gid"), options: {}, **data)
  path = "/projects/{project_gid}/project_briefs"
  path["{project_gid}"] = project_gid
  parse(client.post(path, body: data, options: options)).first
end

.delete_project_brief(client, project_brief_gid: required("project_brief_gid"), options: {}) ⇒ Object

Delete a project brief

Parameters:

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

    (required) Globally unique identifier for the project brief.

  • 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/project_briefs_base.rb', line 34

def delete_project_brief(client, project_brief_gid: required("project_brief_gid"), options: {})
  path = "/project_briefs/{project_brief_gid}"
  path["{project_brief_gid}"] = project_brief_gid
  parse(client.delete(path, options: options)).first
end

.get_project_brief(client, project_brief_gid: required("project_brief_gid"), options: {}) ⇒ Object

Get a project brief

Parameters:

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

    (required) Globally unique identifier for the project brief.

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



46
47
48
49
50
 
# File 'lib/asana/resources/gen/project_briefs_base.rb', line 46

def get_project_brief(client, project_brief_gid: required("project_brief_gid"), options: {})
  path = "/project_briefs/{project_brief_gid}"
  path["{project_brief_gid}"] = project_brief_gid
  parse(client.get(path, options: options)).first
end

.inherited(base) ⇒ Object 



10
11
12
 
# File 'lib/asana/resources/gen/project_briefs_base.rb', line 10

def self.inherited(base)
  Registry.register(base)
end

.update_project_brief(client, project_brief_gid: required("project_brief_gid"), options: {}, **data) ⇒ Object

Update a project brief

Parameters:

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

    (required) Globally unique identifier for the project brief.

  • 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



59
60
61
62
63
 
# File 'lib/asana/resources/gen/project_briefs_base.rb', line 59

def update_project_brief(client, project_brief_gid: required("project_brief_gid"), options: {}, **data)
  path = "/project_briefs/{project_brief_gid}"
  path["{project_brief_gid}"] = project_brief_gid
  parse(client.put(path, body: data, options: options)).first
end