asana 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7e067666054f042bfbbc6c06ba9dc0097be619f6091ee77e4c2cfb8667deead
-  data.tar.gz: 44858543741b3d8c5e421159eb0c170f830299eea6c8897cc91e61149a2adce5
+  metadata.gz: a2da63e8aadca7da78829e16acbf420934d8c39c63eaf2b761c931a84ba84c75
+  data.tar.gz: 5abf90728ebbd012b700bce472dd29e00307218062c6faa8865c151949e7b3db
 SHA512:
-  metadata.gz: 2fcac1831ce273584e5c486793d56fe9c671ef5244d316cd41b3b5092e61c1593c9e47447653237a69e30225908e27f8842a0a5e318fdabbcfd5760e2fe62d4c
-  data.tar.gz: bec2326ce354996184af94806f8da9bf6120fa0f4c3d17c9f494f8d635a2010214c8a2e2e80c200423e73af449cd3799e73499cf93b23b5143a434f70c4a0a44
+  metadata.gz: 2bddb470b53a632fe92412e174c958abfcafa75565b771991864567d3627bdde4560c9082fe46793a3926e32c75a3d913306e2979733a730f2018b424a797298
+  data.tar.gz: 6db94c479e44de7fa283a76fd41db46db547bf30d743fbc1b842a715226fa544bea0fef7498c396b2fbbbeefaea06d17ec55433d511c507ce0bfb989413e63cb

data/.swagger-codegen-ignore

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

data/README.md

@@ -413,7 +413,7 @@ to make a release, as they'll need to run a release script from the
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-[apidocs]: https://asana.com/developers
-[io]: https://asana.com/developers/documentation/getting-started/input-output-options
+[apidocs]: https://developers.asana.com/docs
+[io]: https://developers.asana.com/docs/#input-output-options
 [docs]: http://www.rubydoc.info/github/Asana/ruby-asana/master
 [meta]: https://github.com/asana/asana-api-meta

data/lib/asana/http_client.rb

@@ -108,11 +108,17 @@ module Asana
     #
     # resource_uri - [String] the resource URI relative to the base Asana API
     #                URL, e.g "/tags".
+    # options      - [Hash] the request I/O options
     #
     # Returns an [Asana::HttpClient::Response] if everything went well.
     # Raises [Asana::Errors::APIError] if anything went wrong.
-    def delete(resource_uri)
-      perform_request(:delete, resource_uri)
+    def delete(resource_uri, params: {}, options: {})
+      opts = options.reduce({}) do |acc, (k, v)|
+        acc.tap do |hash|
+          hash[:"opt_#{k}"] = v.is_a?(Array) ? v.join(',') : v
+        end
+      end
+      perform_request(:delete, resource_uri, params.merge(opts), options[:headers])
     end
 
     private

data/lib/asana/resource_includes/collection.rb

@@ -36,6 +36,11 @@ module Asana
         end
       end
 
+      # Public: Returns the last item in the collection.
+      def last
+        @elements.last
+      end
+      
       # Public: Returns the size of the collection.
       def size
         to_a.size

data/lib/asana/resource_includes/resource.rb

@@ -9,10 +9,6 @@ module Asana
       include ResponseHelper
       extend ResponseHelper
 
-      def self.inherited(base)
-        Registry.register(base)
-      end
-
       def initialize(data, client: required('client'))
         @_client = client
         @_data   = data

data/lib/asana/resources/attachment.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/attachments_base'
 
 module Asana
   module Resources
     # 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.
-    class Attachment < Resource
+    class Attachment < AttachmentsBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/batch_api.rb

@@ -0,0 +1,15 @@
+require_relative 'gen/batch_api_base'
+
+module Asana
+  module Resources
+    class BatchAPI < BatchAPIBase
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'batch_apis'
+        end
+      end
+    end
+  end
+end

data/lib/asana/resources/custom_field_settings.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/custom_field_settings_base'
 
 module Asana
   module Resources
@@ -9,11 +8,9 @@ module Asana
     # stores information that is relevant to that particular pairing; for instance,
     # the `is_important` property determines some possible application-specific
     # handling of that custom field and parent.
-    class CustomFieldSetting < Resource
+    class CustomFieldSetting < CustomFieldSettingsBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/custom_fields.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/custom_fields_base'
 
 module Asana
   module Resources
@@ -13,11 +12,9 @@ module Asana
     # fields](/guide/help/premium/custom-fields#gl-lock-fields), which will make
     # them read-only when accessed by other users. Attempting to edit a locked
     # custom field will return HTTP error code `403 Forbidden`.
-    class CustomField < Resource
+    class CustomField < CustomFieldsBase
 
 
-      attr_reader :id
-
       attr_reader :gid
 
       attr_reader :resource_type

data/lib/asana/resources/events.rb

@@ -0,0 +1,28 @@
+require_relative 'gen/events_base'
+
+module Asana
+  module Resources
+    class EventResponse < EventsBase
+
+
+      attr_reader :user
+
+      attr_reader :resource
+
+      attr_reader :type
+
+      attr_reader :action
+
+      attr_reader :parent
+
+      attr_reader :created_at
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'event_responses'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+### 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 AttachmentsBase < Resource
+
+      def self.inherited(base)
+        Registry.register(base)
+      end
+
+      class << self
+        # Delete an attachment
+        #
+        # attachment_gid - [str]  (required) Globally unique identifier for the attachment.
+        # 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 delete_attachment(client, attachment_gid: required("attachment_gid"), options: {})
+          path = "/attachments/{attachment_gid}"
+          path["{attachment_gid}"] = attachment_gid
+          parse(client.delete(path, options: options)).first
+        end
+
+        # Get an attachment
+        #
+        # attachment_gid - [str]  (required) Globally unique identifier for the attachment.
+        # 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_attachment(client, attachment_gid: required("attachment_gid"), options: {})
+          path = "/attachments/{attachment_gid}"
+          path["{attachment_gid}"] = attachment_gid
+          Attachment.new(parse(client.get(path, options: options)).first, client: client)
+        end
+
+        # Get attachments for a task
+        #
+        # task_gid - [str]  (required) The task to operate on.
+        # 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_attachments_for_task(client, task_gid: required("task_gid"), options: {})
+          path = "/tasks/{task_gid}/attachments"
+          path["{task_gid}"] = task_gid
+          Collection.new(parse(client.get(path, options: options)), type: Attachment, client: client)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+### 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 BatchAPIBase < Resource
+
+      def self.inherited(base)
+        Registry.register(base)
+      end
+
+      class << self
+        # Submit parallel requests
+        #
+
+        # 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 create_batch_request(client, options: {}, **data)
+          path = "/batch"
+          Collection.new(parse(client.post(path, body: data, options: options)), type: Resource, client: client)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+### 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 CustomFieldSettingsBase < Resource
+
+      def self.inherited(base)
+        Registry.register(base)
+      end
+
+      class << self
+        # Get a portfolio's custom fields
+        #
+        # portfolio_gid - [str]  (required) Globally unique identifier for the portfolio.
+        # 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_custom_field_settings_for_portfolio(client, portfolio_gid: required("portfolio_gid"), options: {})
+          path = "/portfolios/{portfolio_gid}/custom_field_settings"
+          path["{portfolio_gid}"] = portfolio_gid
+          Collection.new(parse(client.get(path, options: options)), type: CustomFieldSetting, client: client)
+        end
+
+        # Get a project's custom fields
+        #
+        # project_gid - [str]  (required) Globally unique identifier for the project.
+        # 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_custom_field_settings_for_project(client, project_gid: required("project_gid"), options: {})
+          path = "/projects/{project_gid}/custom_field_settings"
+          path["{project_gid}"] = project_gid
+          Collection.new(parse(client.get(path, options: options)), type: CustomFieldSetting, client: client)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+### 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 CustomFieldsBase < Resource
+
+      def self.inherited(base)
+        Registry.register(base)
+      end
+
+      class << self
+        # Create a custom field
+        #
+
+        # 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.
+        # data - [Hash] the attributes to POST
+        def create_custom_field(client, options: {}, **data)
+          path = "/custom_fields"
+          CustomField.new(parse(client.post(path, body: data, options: options)).first, client: client)
+        end
+
+        # Create an enum option
+        #
+        # custom_field_gid - [str]  (required) Globally unique identifier for the custom field.
+        # 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.
+        # data - [Hash] the attributes to POST
+        def create_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data)
+          path = "/custom_fields/{custom_field_gid}/enum_options"
+          path["{custom_field_gid}"] = custom_field_gid
+          parse(client.post(path, body: data, options: options)).first
+        end
+
+        # Delete a custom field
+        #
+        # custom_field_gid - [str]  (required) Globally unique identifier for the custom field.
+        # 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 delete_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {})
+          path = "/custom_fields/{custom_field_gid}"
+          path["{custom_field_gid}"] = custom_field_gid
+          parse(client.delete(path, options: options)).first
+        end
+
+        # Get a custom field
+        #
+        # custom_field_gid - [str]  (required) Globally unique identifier for the custom field.
+        # 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_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {})
+          path = "/custom_fields/{custom_field_gid}"
+          path["{custom_field_gid}"] = custom_field_gid
+          CustomField.new(parse(client.get(path, options: options)).first, client: client)
+        end
+
+        # Get a workspace's custom fields
+        #
+        # workspace_gid - [str]  (required) Globally unique identifier for the workspace or organization.
+        # 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_custom_fields_for_workspace(client, workspace_gid: required("workspace_gid"), options: {})
+          path = "/workspaces/{workspace_gid}/custom_fields"
+          path["{workspace_gid}"] = workspace_gid
+          Collection.new(parse(client.get(path, options: options)), type: CustomField, client: client)
+        end
+
+        # Reorder a custom field's enum
+        #
+        # custom_field_gid - [str]  (required) Globally unique identifier for the custom field.
+        # 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 insert_enum_option_for_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data)
+          path = "/custom_fields/{custom_field_gid}/enum_options/insert"
+          path["{custom_field_gid}"] = custom_field_gid
+          parse(client.post(path, body: data, options: options)).first
+        end
+
+        # Update a custom field
+        #
+        # custom_field_gid - [str]  (required) Globally unique identifier for the custom field.
+        # 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_custom_field(client, custom_field_gid: required("custom_field_gid"), options: {}, **data)
+          path = "/custom_fields/{custom_field_gid}"
+          path["{custom_field_gid}"] = custom_field_gid
+          CustomField.new(parse(client.put(path, body: data, options: options)).first, client: client)
+        end
+
+        # Update an enum option
+        #
+        # enum_option_gid - [str]  (required) Globally unique identifier for the enum option.
+        # 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_enum_option(client, enum_option_gid: required("enum_option_gid"), options: {}, **data)
+          path = "/enum_options/{enum_option_gid}"
+          path["{enum_option_gid}"] = enum_option_gid
+          parse(client.put(path, body: data, options: options)).first
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+### 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 EventsBase < Resource
+
+      def self.inherited(base)
+        Registry.register(base)
+      end
+
+      class << self
+        # Get events on a resource
+        #
+
+        # resource - [str]  (required) A resource ID to subscribe to. The resource can be a task or project.
+        # sync - [str]  A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.*
+        # 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_events(client, resource: nil, sync: nil, options: {})
+          path = "/events"
+          params = { resource: resource, sync: sync }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get(path, params: params, options: options)), type: Resource, client: client)
+        end
+
+      end
+    end
+  end
+end