asana 0.9.3 → 0.10.0

data/lib/asana/resources/gen/workspaces_base.rb

@@ -0,0 +1,82 @@
+### WARNING: This file is auto-generated by our OpenAPI spec. Do not
+### edit it manually.
+
+require_relative '../../resource_includes/response_helper'
+
+module Asana
+  module Resources
+    class WorkspacesBase < Resource
+
+      def self.inherited(base)
+        Registry.register(base)
+      end
+
+      class << self
+        # 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[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.
+        # > 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
+        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 a workspace
+        #
+        # workspace_gid - [str]  (required) Globally unique identifier for the workspace or organization.
+        # options - [Hash] the request I/O options
+        # > opt_fields - [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.
+        # > 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.
+        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 multiple workspaces
+        #
+
+        # 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[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.
+        # > 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.
+        def get_workspaces(client, options: {})
+          path = "/workspaces"
+          Collection.new(parse(client.get(path, options: options)), type: Workspace, client: client)
+        end
+
+        # 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[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.
+        # > 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
+        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 a workspace
+        #
+        # workspace_gid - [str]  (required) Globally unique identifier for the workspace or organization.
+        # options - [Hash] the request I/O options
+        # > opt_fields - [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.
+        # > 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
+        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
+
+      end
+    end
+  end
+end

data/lib/asana/resources/job.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/jobs_base'
 
 module Asana
   module Resources
@@ -7,7 +6,7 @@ module Asana
     #
     # Jobs are created when an endpoint requests an action that will be handled asynchronously.
     # Such as project or task duplication.
-    class Job < Resource
+    class Job < JobsBase
 
 
       attr_reader :gid

data/lib/asana/resources/organization_export.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/organization_exports_base'
 
 module Asana
   module Resources
@@ -16,11 +15,9 @@ module Asana
     #
     # **Note:** These endpoints are only available to [Service Accounts](/guide/help/premium/service-accounts)
     # of an [Enterprise](/enterprise) Organization.
-    class OrganizationExport < Resource
+    class OrganizationExport < OrganizationExportsBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :created_at

data/lib/asana/resources/portfolio.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/portfolios_base'
 
 module Asana
   module Resources
@@ -10,11 +9,9 @@ module Asana
     #
     # Portfolios have some restrictions on size. Each portfolio has a maximum of 250
     # items and, like projects, a maximum of 20 custom fields.
-    class Portfolio < Resource
+    class Portfolio < PortfoliosBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/portfolio_membership.rb

@@ -1,14 +1,11 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/portfolio_memberships_base'
 
 module Asana
   module Resources
     # This object determines if a user is a member of a portfolio.
-    class PortfolioMembership < Resource
+    class PortfolioMembership < PortfolioMembershipsBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/project.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/projects_base'
 
 module Asana
   module Resources
@@ -12,13 +11,11 @@ module Asana
     # change the team of a project via the API. Non-organization workspaces do not
     # have teams and so you should not specify the team of project in a regular
     # workspace.
-    class Project < Resource
+    class Project < ProjectsBase
 
       include EventSubscription
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/project_membership.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/project_memberships_base'
 
 module Asana
   module Resources
@@ -7,11 +6,9 @@ module Asana
     # in a project comes with associated permissions. These permissions (whether a
     # user has full access to the project or comment-only access) are accessible
     # through the project memberships endpoints described here.
-    class ProjectMembership < Resource
+    class ProjectMembership < ProjectMembershipsBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/project_status.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/project_statuses_base'
 
 module Asana
   module Resources
@@ -9,11 +8,9 @@ module Asana
     # at risk, and "red" for projects that are behind.
     #
     # Project statuses can be created and deleted, but not modified.
-    class ProjectStatus < Resource
+    class ProjectStatus < ProjectStatusesBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/section.rb

@@ -1,16 +1,13 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/sections_base'
 
 module Asana
   module Resources
     # A _section_ is a subdivision of a project that groups tasks together. It can
     # either be a header above a list of tasks in a list view or a column in a
     # board view of a project.
-    class Section < Resource
+    class Section < SectionsBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type
@@ -56,23 +53,7 @@ module Asana
         # options - [Hash] the request I/O options.
         def find_by_id(client, id, options: {})
 
-          self.new(parse(client.get("/sections/#{id}", options: options)).first, client: client)
-        end
-
-        # Add a task to a specific, existing section. This will remove the task from other sections of the project.
-        #
-        # The task will be inserted at the top of a section unless an `insert_before` or `insert_after` parameter is declared.
-        #
-        # This does not work for separators (tasks with the `resource_subtype` of section).
-        #
-        # task - [Gid] The task to add to this section
-        # insert_before - [Gid] Insert the given task immediately before the task specified by this parameter. Cannot be provided together with `insert_after`.
-        # insert_after - [Gid] Insert the given task immediately after the task specified by this parameter. Cannot be provided together with `insert_before`.
-        # options - [Hash] the request I/O options.
-        # data - [Hash] the attributes to post.
-        def add_task(client, task: required("task"), insert_before: nil, insert_after: nil, options: {}, **data)
-          with_params = data.merge(insert_before: insert_before, insert_after: insert_after).reject { |_,v| v.nil? || Array(v).empty? }
-          Task.new(parse(client.post("/sections/#{task}/addTask", body: with_params, options: options)).first, client: client)
+          self.new(parse(client.get("/sections/#{gid}", options: options)).first, client: client)
         end
       end
 
@@ -107,6 +88,21 @@ module Asana
         client.delete("/sections/#{gid}") && true
       end
 
+      # Add a task to a specific, existing section. This will remove the task from other sections of the project.
+      #
+      # The task will be inserted at the top of a section unless an `insert_before` or `insert_after` parameter is declared.
+      #
+      # This does not work for separators (tasks with the `resource_subtype` of section).
+      #
+      # insert_before - [Gid] Insert the given task immediately before the task specified by this parameter. Cannot be provided together with `insert_after`.
+      # insert_after - [Gid] Insert the given task immediately after the task specified by this parameter. Cannot be provided together with `insert_before`.
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def add_task(insert_before: nil, insert_after: nil, options: {}, **data)
+        with_params = data.merge(insert_before: insert_before, insert_after: insert_after).reject { |_,v| v.nil? || Array(v).empty? }
+        Task.new(parse(client.post("/sections/#{gid}/addTask", body: with_params, options: options)).first, client: client)
+      end
+
       # Move sections relative to each other in a board view. One of
       # `before_section` or `after_section` is required.
       #

data/lib/asana/resources/story.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/stories_base'
 
 module Asana
   module Resources
@@ -7,11 +6,9 @@ module Asana
     # system. Stories are generated by the system whenever users take actions such
     # as creating or assigning tasks, or moving tasks between projects. _Comments_
     # are also a form of user-generated story.
-    class Story < Resource
+    class Story < StoriesBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/tag.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/tags_base'
 
 module Asana
   module Resources
@@ -10,11 +9,9 @@ module Asana
     # simplify them in the future so it is not encouraged to rely too heavily on it.
     # Unlike projects, tags do not provide any ordering on the tasks they
     # are associated with.
-    class Tag < Resource
+    class Tag < TagsBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/task.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/tasks_base'
 
 module Asana
   module Resources
@@ -7,15 +6,13 @@ module Asana
     # centered. In the Asana application, multiple tasks populate the middle pane
     # according to some view parameters, and the set of selected tasks determines
     # the more detailed information presented in the details pane.
-    class Task < Resource
+    class Task < TasksBase
 
       include AttachmentUploading
 
       include EventSubscription
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/team.rb

@@ -1,15 +1,12 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/teams_base'
 
 module Asana
   module Resources
     # A _team_ is used to group related projects and people together within an
     # organization. Each project in an organization is associated with a team.
-    class Team < Resource
+    class Team < TeamsBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/team_membership.rb

@@ -0,0 +1,26 @@
+require_relative 'gen/team_memberships_base'
+
+module Asana
+  module Resources
+    class TeamMembership < TeamMembershipsBase
+
+
+      attr_reader :gid
+
+      attr_reader :resource_type
+
+      attr_reader :user
+
+      attr_reader :team
+
+      attr_reader :is_guest
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'team_memberships'
+        end
+      end
+    end
+  end
+end

data/lib/asana/resources/typeahead.rb

@@ -0,0 +1,22 @@
+require_relative 'gen/typeahead_base'
+
+module Asana
+  module Resources
+    class Typeahead < TypeaheadBase
+
+
+      attr_reader :gid
+
+      attr_reader :resource_type
+
+      attr_reader :name
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'typeaheads'
+        end
+      end
+    end
+  end
+end

data/lib/asana/resources/user.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/users_base'
 
 module Asana
   module Resources
@@ -9,11 +8,9 @@ module Asana
     # Like other objects in the system, users are referred to by numerical IDs.
     # However, the special string identifier `me` can be used anywhere
     # a user ID is accepted, to refer to the current authenticated user.
-    class User < Resource
+    class User < UsersBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/user_task_list.rb

@@ -1,5 +1,4 @@
-### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
-### edit it manually.
+require_relative 'gen/user_task_lists_base'
 
 module Asana
   module Resources
@@ -14,11 +13,9 @@ module Asana
     # approach; read up on [task
     # auto-promotion](/guide/help/fundamentals/my-tasks#gl-auto-promote) for more
     # infomation.
-    class UserTaskList < Resource
+    class UserTaskList < UserTaskListsBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type