class Asana::Resources::WorkspacesBase

Public Class Methods

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

Add a user to a workspace or organization

workspace_gid - [str] (required) Globally unique identifier for the workspace or organization. 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/workspaces_base.rb, line 22
def add_user_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}, **data)
  path = "/workspaces/{workspace_gid}/addUser"
  path["{workspace_gid}"] = workspace_gid
  User.new(parse(client.post(path, body: data, options: options)).first, client: client)
end
get_workspace(client, workspace_gid: required("workspace_gid"), options: {}) click to toggle source

Get a workspace

workspace_gid - [str] (required) Globally unique identifier for the workspace or organization. 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/workspaces_base.rb, line 34
def get_workspace(client, workspace_gid: required("workspace_gid"), options: {})
  path = "/workspaces/{workspace_gid}"
  path["{workspace_gid}"] = workspace_gid
  Workspace.new(parse(client.get(path, options: options)).first, client: client)
end
get_workspaces(client, options: {}) click to toggle source

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/workspaces_base.rb, line 48
def get_workspaces(client, options: {})
  path = "/workspaces"
  Collection.new(parse(client.get(path, options: options)), type: Workspace, client: client)
end
inherited(base) click to toggle source
# File lib/asana/resources/gen/workspaces_base.rb, line 10
def self.inherited(base)
  Registry.register(base)
end
remove_user_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}, **data) click to toggle source

Remove a user from a workspace or organization

workspace_gid - [str] (required) Globally unique identifier for the workspace or organization. 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/workspaces_base.rb, line 60
def remove_user_for_workspace(client, workspace_gid: required("workspace_gid"), options: {}, **data)
  path = "/workspaces/{workspace_gid}/removeUser"
  path["{workspace_gid}"] = workspace_gid
  parse(client.post(path, body: data, options: options)).first
end
update_workspace(client, workspace_gid: required("workspace_gid"), options: {}, **data) click to toggle source

Update a workspace

workspace_gid - [str] (required) Globally unique identifier for the workspace or organization. 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/workspaces_base.rb, line 73
def update_workspace(client, workspace_gid: required("workspace_gid"), options: {}, **data)
  path = "/workspaces/{workspace_gid}"
  path["{workspace_gid}"] = workspace_gid
  Workspace.new(parse(client.put(path, body: data, options: options)).first, client: client)
end