Merge pull request #103 from Asana/rossgrambo-openapi-convert

Conversion to openapi spec

Author: rossgrambo-zz

.swagger-codegen-ignore

@@ -0,0 +1,4 @@
+# Swagger Codegen Ignore
+
+docs/*
+test/*

README.md

@@ -180,7 +180,7 @@ lint and tests.
 ### Code generation
 
 The specific Asana resource classes under `gen` (`_Tag`, `_Workspace`, `_Task`, etc) are
-generated code, hence they shouldn't be modified by hand. See the [asana-api-meta][meta] repo for details.
+generated code, hence they shouldn't be modified by hand.
 
 ### Deployment
 
@@ -208,3 +208,5 @@ Travis CI will automatically build and deploy the tagged release to `pypi`.
 
 [pypi-url]: https://pypi.python.org/pypi/asana/
 [pypi-image]: https://img.shields.io/pypi/v/asana.svg?style=flat-square
+
+[asana-docs]: https://developers.asana.com/docs

asana/__init__.py

@@ -1,5 +1,5 @@
 __title__ = 'asana'
-__version__ = '0.9.2'
+__version__ = '0.10.0'
 __license__ = 'MIT'
 __copyright__ = 'Copyright 2016 Asana, Inc.'
 

asana/resources/__init__.py

@@ -1,5 +1,6 @@
 from . import (
     attachments,
+    batch_api,
     custom_field_settings,
     custom_fields,
     events,
@@ -15,8 +16,10 @@
     tags,
     tasks,
     teams,
+    typeahead,
     users,
     user_task_lists,
     webhooks,
+    workspace_memberships,
     workspaces
 )

asana/resources/attachments.py

@@ -8,3 +8,25 @@ def create_on_task(self, task_id, file_content, file_name, file_content_type=Non
         """Upload an attachment for a task. Accepts a file object or string, file name, and optional file Content-Type"""
         path = '/tasks/%s/attachments' % (task_id)
         return self.client.request('post', path, files=[('file', (file_name, file_content, file_content_type))], **options)
+
+    def find_by_id(self, attachment, params={}, **options):
+        """Returns the full record for a single attachment.
+
+        Parameters
+        ----------
+        attachment : {Gid} Globally unique identifier for the attachment.
+        [params] : {Object} Parameters for the request
+        """
+        path = "/attachments/%s" % (attachment)
+        return self.client.get(path, params, **options)
+
+    def find_by_task(self, task, params={}, **options):
+        """Returns the compact records for all attachments on the task.
+
+        Parameters
+        ----------
+        task : {Gid} Globally unique identifier for the task.
+        [params] : {Object} Parameters for the request
+        """
+        path = "/tasks/%s/attachments" % (task)
+        return self.client.get_collection(path, params, **options)

asana/resources/batch_api.py

@@ -0,0 +1,6 @@
+
+from .gen.batch_api import _BatchAPI
+
+class BatchAPI(_BatchAPI):
+    """BatchAPI resource"""
+    pass

asana/resources/custom_field_settings.py

@@ -3,4 +3,24 @@
 
 class CustomFieldSettings(_CustomFieldSettings):
     """Custom Field Settings resource"""
-    pass
+    def find_by_project(self, project, params={}, **options):
+        """Returns a list of all of the custom fields settings on a project.
+
+        Parameters
+        ----------
+        project : {Gid} The ID of the project for which to list custom field settings
+        [params] : {Object} Parameters for the request
+        """
+        path = "/projects/%s/custom_field_settings" % (project)
+        return self.client.get_collection(path, params, **options)
+
+    def find_by_portfolio(self, portfolio, params={}, **options):
+        """Returns a list of all of the custom fields settings on a portfolio.
+
+        Parameters
+        ----------
+        portfolio : {Gid} The ID of the portfolio for which to list custom field settings
+        [params] : {Object} Parameters for the request
+        """
+        path = "/portfolios/%s/custom_field_settings" % (portfolio)
+        return self.client.get_collection(path, params, **options)

asana/resources/custom_fields.py

@@ -8,3 +8,133 @@ def add_enum_option(self, custom_field, params={}, **options):
 
     def reorder_enum_option(self, custom_field, params={}, **options):
         self.insert_enum_option(custom_field, params, **options)
+
+    def create(self, params={}, **options):
+        """Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set.
+
+        A custom field's `name` must be unique within a workspace and not conflict with names of existing task properties such as 'Due Date' or 'Assignee'. A custom field's `type` must be one of  'text', 'enum', or 'number'.
+
+        Returns the full record of the newly created custom field.
+
+        Parameters
+        ----------
+        [data] : {Object} Data for the request
+          - workspace : {Gid} The workspace to create a custom field in.
+          - resource_subtype : {String} The type of the custom field. Must be one of the given values.
+          - [type] : {String} **Deprecated: New integrations should prefer the `resource_subtype` parameter.**
+          - name : {String} The name of the custom field.
+          - [description] : {String} The description of the custom field.
+          - [precision] : {Integer} The number of decimal places for the numerical values. Required if the custom field is of type 'number'.
+          - [enum_options] : {String} The discrete values the custom field can assume. Required if the custom field is of type 'enum'.
+        """
+        return self.client.post("/custom_fields", params, **options)
+
+    def find_by_id(self, custom_field, params={}, **options):
+        """Returns the complete definition of a custom field's metadata.
+
+        Parameters
+        ----------
+        custom_field : {Gid} Globally unique identifier for the custom field.
+        [params] : {Object} Parameters for the request
+        """
+        path = "/custom_fields/%s" % (custom_field)
+        return self.client.get(path, params, **options)
+
+    def find_by_workspace(self, workspace, params={}, **options):
+        """Returns a list of the compact representation of all of the custom fields in a workspace.
+
+        Parameters
+        ----------
+        workspace : {Gid} The workspace or organization to find custom field definitions in.
+        [params] : {Object} Parameters for the request
+        """
+        path = "/workspaces/%s/custom_fields" % (workspace)
+        return self.client.get_collection(path, params, **options)
+
+    def update(self, custom_field, params={}, **options):
+        """A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged
+
+        When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field.
+
+        An enum custom field's `enum_options` cannot be updated with this endpoint. Instead see "Work With Enum Options" for information on how to update `enum_options`.
+
+        Locked custom fields can only be updated by the user who locked the field.
+
+        Returns the complete updated custom field record.
+
+        Parameters
+        ----------
+        custom_field : {Gid} Globally unique identifier for the custom field.
+        [data] : {Object} Data for the request
+        """
+        path = "/custom_fields/%s" % (custom_field)
+        return self.client.put(path, params, **options)
+
+    def delete(self, custom_field, params={}, **options):
+        """A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field.
+
+        Locked custom fields can only be deleted by the user who locked the field.
+
+        Returns an empty data record.
+
+        Parameters
+        ----------
+        custom_field : {Gid} Globally unique identifier for the custom field.
+        """
+        path = "/custom_fields/%s" % (custom_field)
+        return self.client.delete(path, params, **options)
+
+    def create_enum_option(self, custom_field, params={}, **options):
+        """Creates an enum option and adds it to this custom field's list of enum options. A custom field can have at most 50 enum options (including disabled options). By default new enum options are inserted at the end of a custom field's list.
+
+        Locked custom fields can only have enum options added by the user who locked the field.
+
+        Returns the full record of the newly created enum option.
+
+        Parameters
+        ----------
+        custom_field : {Gid} Globally unique identifier for the custom field.
+        [data] : {Object} Data for the request
+          - name : {String} The name of the enum option.
+          - [color] : {String} The color of the enum option. Defaults to 'none'.
+          - [insert_before] : {Gid} An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.
+          - [insert_after] : {Gid} An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.
+        """
+        path = "/custom_fields/%s/enum_options" % (custom_field)
+        return self.client.post(path, params, **options)
+
+    def update_enum_option(self, enum_option, params={}, **options):
+        """Updates an existing enum option. Enum custom fields require at least one enabled enum option.
+
+        Locked custom fields can only be updated by the user who locked the field.
+
+        Returns the full record of the updated enum option.
+
+        Parameters
+        ----------
+        enum_option : {Gid} Globally unique identifier for the enum option.
+        [data] : {Object} Data for the request
+          - name : {String} The name of the enum option.
+          - [color] : {String} The color of the enum option. Defaults to 'none'.
+          - [enabled] : {Boolean} Whether or not the enum option is a selectable value for the custom field.
+        """
+        path = "/enum_options/%s" % (enum_option)
+        return self.client.put(path, params, **options)
+
+    def insert_enum_option(self, custom_field, params={}, **options):
+        """Moves a particular enum option to be either before or after another specified enum option in the custom field.
+
+        Locked custom fields can only be reordered by the user who locked the field.
+
+        Parameters
+        ----------
+        custom_field : {Gid} Globally unique identifier for the custom field.
+        [data] : {Object} Data for the request
+          - enum_option : {Gid} The ID of the enum option to relocate.
+          - name : {String} The name of the enum option.
+          - [color] : {String} The color of the enum option. Defaults to 'none'.
+          - [before_enum_option] : {Gid} An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.
+          - [after_enum_option] : {Gid} An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.
+        """
+        path = "/custom_fields/%s/enum_options/insert" % (custom_field)
+        return self.client.post(path, params, **options)

asana/resources/gen/__init__.py

@@ -0,0 +1,25 @@
+from . import (
+    attachments,
+    batch_api,
+    custom_field_settings,
+    custom_fields,
+    events,
+    jobs,
+    organization_exports,
+    portfolios,
+    portfolio_memberships,
+    project_memberships,
+    project_statuses,
+    projects,
+    sections,
+    stories,
+    tags,
+    tasks,
+    teams,
+    typeahead,
+    users,
+    user_task_lists,
+    webhooks,
+    workspace_memberships,
+    workspaces
+)

asana/resources/gen/attachments.py

@@ -1,32 +1,49 @@
-
+# coding=utf-8
 class _Attachments:
-    """An _attachment_ object represents any file attached to a task in Asana,
-    whether it's an uploaded file or one associated via a third-party service
-    such as Dropbox or Google Drive.
-    """
 
     def __init__(self, client=None):
         self.client = client
-  
-    def find_by_id(self, attachment, params={}, **options): 
-        """Returns the full record for a single attachment.
 
-        Parameters
-        ----------
-        attachment : {Gid} Globally unique identifier for the attachment.
-        [params] : {Object} Parameters for the request
+    def delete_attachment(self, attachment_gid, params=None, **options):
+        """Delete an attachment
+        :param str attachment_gid: (required) Globally unique identifier for the attachment.
+        :param Object params: Parameters for the request
+        :param **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.
+        :return: Object
+        """
+        if params is None:
+            params = {}
+        path = "/attachments/{attachment_gid}".replace("{attachment_gid}", attachment_gid)
+        return self.client.delete(path, params, **options)
+
+    def get_attachment(self, attachment_gid, params=None, **options):
+        """Get an attachment
+        :param str attachment_gid: (required) Globally unique identifier for the attachment.
+        :param Object params: Parameters for the request
+        :param **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.
+        :return: Object
         """
-        path = "/attachments/%s" % (attachment)
+        if params is None:
+            params = {}
+        path = "/attachments/{attachment_gid}".replace("{attachment_gid}", attachment_gid)
         return self.client.get(path, params, **options)
-        
-    def find_by_task(self, task, params={}, **options): 
-        """Returns the compact records for all attachments on the task.
 
-        Parameters
-        ----------
-        task : {Gid} Globally unique identifier for the task.
-        [params] : {Object} Parameters for the request
+    def get_attachments_for_task(self, task_gid, params=None, **options):
+        """Get attachments for a task
+        :param str task_gid: (required) The task to operate on.
+        :param Object params: Parameters for the request
+        :param **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.
+        :return: Object
         """
-        path = "/tasks/%s/attachments" % (task)
+        if params is None:
+            params = {}
+        path = "/tasks/{task_gid}/attachments".replace("{task_gid}", task_gid)
         return self.client.get_collection(path, params, **options)
-