Class: Asana::Resources::TagsBase

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

Direct Known Subclasses

Tag

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

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.

Parameters:

  • data (Hash)

    the attributes to POST


22
23
24
25
# File 'lib/asana/resources/gen/tags_base.rb', line 22

def create_tag(client, options: {}, **data)
  path = "/tags"
  Tag.new(parse(client.post(path, body: data, options: options)).first, client: client)
end

.create_tag_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}, **data) ⇒ Object

Create a tag in a workspace

Parameters:

  • workspace_gid (str) (defaults to: required("workspace_gid"))

    (required) Globally unique identifier for the workspace or organization.

  • 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


34
35
36
37
38
# File 'lib/asana/resources/gen/tags_base.rb', line 34

def create_tag_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}, **data)
  path = "/workspaces/{workspace_gid}/tags"
  path["{workspace_gid}"] = workspace_gid
  Tag.new(parse(client.post(path, body: data, options: options)).first, client: client)
end

.delete_tag(client, tag_gid: required("tag_gid"), options: {}) ⇒ Object

Delete a tag

Parameters:

  • tag_gid (str) (defaults to: required("tag_gid"))

    (required) Globally unique identifier for the tag.

  • 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/tags_base.rb', line 48

def delete_tag(client, tag_gid: required("tag_gid"), options: {})
  path = "/tags/{tag_gid}"
  path["{tag_gid}"] = tag_gid
  parse(client.delete(path, options: options)).first
end

.get_tag(client, tag_gid: required("tag_gid"), options: {}) ⇒ Object

Get a tag

Parameters:

  • tag_gid (str) (defaults to: required("tag_gid"))

    (required) Globally unique identifier for the tag.

  • 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/tags_base.rb', line 62

def get_tag(client, tag_gid: required("tag_gid"), options: {})
  path = "/tags/{tag_gid}"
  path["{tag_gid}"] = tag_gid
  Tag.new(parse(client.get(path, options: options)).first, client: client)
end

.get_tags(client, workspace: nil, options: {}) ⇒ Object

workspace - [str] The workspace to filter tags on.

Parameters:

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


77
78
79
80
81
# File 'lib/asana/resources/gen/tags_base.rb', line 77

def get_tags(client, workspace: nil, options: {})
  path = "/tags"
  params = { workspace: workspace }.reject { |_,v| v.nil? || Array(v).empty? }
  Collection.new(parse(client.get(path, params: params, options: options)), type: Tag, client: client)
end

.get_tags_for_task(client, task_gid: required("task_gid"), options: {}) ⇒ Object

Get a task's tags

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.


91
92
93
94
95
# File 'lib/asana/resources/gen/tags_base.rb', line 91

def get_tags_for_task(client, task_gid: required("task_gid"), options: {})
  path = "/tasks/{task_gid}/tags"
  path["{task_gid}"] = task_gid
  Collection.new(parse(client.get(path, options: options)), type: Tag, client: client)
end

.get_tags_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}) ⇒ Object

Get tags in a workspace

Parameters:

  • workspace_gid (str) (defaults to: required("workspace_gid"))

    (required) Globally unique identifier for the workspace or organization.

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


105
106
107
108
109
# File 'lib/asana/resources/gen/tags_base.rb', line 105

def get_tags_for_workspace(client, workspace_gid: required("workspace_gid"), options: {})
  path = "/workspaces/{workspace_gid}/tags"
  path["{workspace_gid}"] = workspace_gid
  Collection.new(parse(client.get(path, options: options)), type: Tag, client: client)
end

.inherited(base) ⇒ Object


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

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

.update_tag(client, tag_gid: required("tag_gid"), options: {}, **data) ⇒ Object

Update a tag

Parameters:

  • tag_gid (str) (defaults to: required("tag_gid"))

    (required) Globally unique identifier for the tag.

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

  • data (Hash)

    the attributes to PUT


120
121
122
123
124
# File 'lib/asana/resources/gen/tags_base.rb', line 120

def update_tag(client, tag_gid: required("tag_gid"), options: {}, **data)
  path = "/tags/{tag_gid}"
  path["{tag_gid}"] = tag_gid
  Tag.new(parse(client.put(path, body: data, options: options)).first, client: client)
end