RubyGems - asana - Versions diffs - 0.10.3 → 2.0.3 - Mend

asana 0.10.3 → 2.0.3

Files changed (86) hide show

checksums.yaml +4 -4
data/.github/workflows/build.yml +24 -0
data/.github/workflows/pubilsh-to-rubygem.yml +18 -0
data/.github/workflows/publish-to-github-releases.yml +16 -0
data/.gitignore +0 -1
data/.rubocop.yml +38 -3
data/.ruby-version +1 -1
data/Appraisals +8 -3
data/Gemfile +7 -3
data/Gemfile.lock +166 -0
data/Guardfile +12 -10
data/README.md +45 -20
data/Rakefile +20 -27
data/VERSION +1 -1
data/asana.gemspec +20 -18
data/examples/Gemfile.lock +2 -2
data/examples/cli_app.rb +2 -2
data/examples/events.rb +3 -3
data/examples/personal_access_token.rb +2 -2
data/lib/asana/authentication/oauth2/access_token_authentication.rb +4 -1
data/lib/asana/authentication/oauth2/bearer_token_authentication.rb +3 -2
data/lib/asana/authentication/oauth2/client.rb +2 -0
data/lib/asana/authentication/oauth2.rb +6 -4
data/lib/asana/authentication/token_authentication.rb +3 -1
data/lib/asana/authentication.rb +2 -0
data/lib/asana/client/configuration.rb +6 -5
data/lib/asana/client.rb +13 -11
data/lib/asana/errors.rb +16 -11
data/lib/asana/http_client/environment_info.rb +9 -8
data/lib/asana/http_client/error_handling.rb +26 -20
data/lib/asana/http_client/response.rb +2 -0
data/lib/asana/http_client.rb +66 -65
data/lib/asana/resource_includes/attachment_uploading.rb +6 -6
data/lib/asana/resource_includes/collection.rb +4 -4
data/lib/asana/resource_includes/event.rb +2 -0
data/lib/asana/resource_includes/event_subscription.rb +2 -0
data/lib/asana/resource_includes/events.rb +4 -1
data/lib/asana/resource_includes/registry.rb +2 -0
data/lib/asana/resource_includes/resource.rb +8 -5
data/lib/asana/resource_includes/response_helper.rb +2 -0
data/lib/asana/resources/audit_log_api.rb +42 -0
data/lib/asana/resources/gen/attachments_base.rb +7 -6
data/lib/asana/resources/gen/audit_log_api_base.rb +37 -0
data/lib/asana/resources/gen/goal_relationships_base.rb +83 -0
data/lib/asana/resources/gen/goals_base.rb +153 -0
data/lib/asana/resources/gen/memberships_base.rb +71 -0
data/lib/asana/resources/gen/portfolios_base.rb +3 -3
data/lib/asana/resources/gen/project_briefs_base.rb +68 -0
data/lib/asana/resources/gen/project_templates_base.rb +73 -0
data/lib/asana/resources/gen/projects_base.rb +17 -4
data/lib/asana/resources/gen/status_updates_base.rb +72 -0
data/lib/asana/resources/gen/tasks_base.rb +13 -15
data/lib/asana/resources/gen/teams_base.rb +41 -13
data/lib/asana/resources/gen/time_periods_base.rb +47 -0
data/lib/asana/resources/gen/typeahead_base.rb +2 -2
data/lib/asana/resources/gen/users_base.rb +3 -4
data/lib/asana/resources/gen/webhooks_base.rb +13 -0
data/lib/asana/resources/gen/workspaces_base.rb +1 -1
data/lib/asana/resources/goal.rb +54 -0
data/lib/asana/resources/goal_relationship.rb +32 -0
data/lib/asana/resources/membership.rb +20 -0
data/lib/asana/resources/portfolio.rb +3 -3
data/lib/asana/resources/project_brief.rb +30 -0
data/lib/asana/resources/project_template.rb +36 -0
data/lib/asana/resources/status_update.rb +54 -0
data/lib/asana/resources/time_period.rb +30 -0
data/lib/asana/resources/typeahead.rb +1 -1
data/lib/asana/resources.rb +4 -4
data/lib/asana/ruby2_0_0_compatibility.rb +2 -0
data/lib/asana/version.rb +1 -1
data/lib/asana.rb +2 -0
data/package-lock.json +115 -0
data/samples/attachments_sample.yaml +4 -4
data/samples/audit_log_api_sample.yaml +11 -0
data/samples/goal_relationships_sample.yaml +51 -0
data/samples/goals_sample.yaml +101 -0
data/samples/memberships_sample.yaml +41 -0
data/samples/project_briefs_sample.yaml +41 -0
data/samples/project_templates_sample.yaml +41 -0
data/samples/projects_sample.yaml +10 -0
data/samples/status_updates_sample.yaml +41 -0
data/samples/teams_sample.yaml +24 -4
data/samples/time_periods_sample.yaml +21 -0
data/samples/webhooks_sample.yaml +10 -0
metadata +75 -40
data/.travis.yml +0 -16

data/lib/asana/http_client.rb CHANGED Viewed

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require 'faraday'
-require 'faraday_middleware'
-require 'faraday_middleware/multi_json'
+require 'faraday/follow_redirects'
 require_relative 'http_client/error_handling'
 require_relative 'http_client/environment_info'
@@ -11,7 +12,7 @@ module Asana
   # parsing and common options.
   class HttpClient
     # Internal: The API base URI.
-    BASE_URI = 'https://app.asana.com/api/1.0'.freeze
+    BASE_URI = 'https://app.asana.com/api/1.0'
     # Public: Initializes an HttpClient to make requests to the Asana API.
     #
@@ -130,7 +131,8 @@ module Asana
         yield builder if request_config
         configure_format(builder)
         add_middleware(builder)
-        @config.call(builder) if @config
+        configure_redirects(builder)
+        @config&.call(builder)
         use_adapter(builder, @adapter)
       end
     end
@@ -147,13 +149,16 @@ module Asana
     end
     def configure_format(builder)
-      builder.request :multi_json
-      builder.response :multi_json
+      builder.request :json
+      builder.response :json
     end
     def add_middleware(builder)
       builder.use Faraday::Response::RaiseError
-      builder.use FaradayMiddleware::FollowRedirects
+    end
+    def configure_redirects(builder)
+      builder.response :follow_redirects
     end
     def use_adapter(builder, adapter)
@@ -170,79 +175,75 @@ module Asana
     end
     def log_request(method, url, body)
-      STDERR.puts format('[%s] %s %s (%s)',
-                         self.class,
-                         method.to_s.upcase,
-                         url,
-                         body.inspect)
+      warn format('[%<klass>s] %<method>s %<url>s (%<body>s)',
+                  klass: self.class,
+                  method: method.to_s.upcase,
+                  url: url,
+                  body: body.inspect)
     end
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def log_asana_change_headers(request_headers, response_headers)
       change_header_key = nil
       response_headers.each_key do |key|
-        if key.downcase == 'asana-change'
-            change_header_key = key
-        end
+        change_header_key = key if key.downcase == 'asana-change'
       end
-      if change_header_key != nil
-        accounted_for_flags = Array.new
+      return if change_header_key.nil?
-        if request_headers == nil
-          request_headers = {}
-        end
-        # Grab the request's asana-enable flags
-        request_headers.each_key do |req_header|
-          if req_header.downcase == 'asana-enable'
-            request_headers[req_header].split(',').each do |flag|
-              accounted_for_flags.push(flag)
-            end
-          elsif req_header.downcase == 'asana-disable'
-            request_headers[req_header].split(',').each do |flag|
-              accounted_for_flags.push(flag)
-            end
+      accounted_for_flags = []
+      request_headers = {} if request_headers.nil?
+      # Grab the request's asana-enable flags
+      request_headers.each_key do |req_header|
+        case req_header.downcase
+        when 'asana-enable', 'asana-disable'
+          request_headers[req_header].split(',').each do |flag|
+            accounted_for_flags.push(flag)
           end
         end
+      end
+      changes = response_headers[change_header_key].split(',')
-        changes = response_headers[change_header_key].split(',')
-        changes.each do |unsplit_change|
-          change = unsplit_change.split(';')
-          name = nil
-          info = nil
-          affected = nil
-          change.each do |unsplit_field|
-            field = unsplit_field.split('=')
-            field[0].strip!
-            field[1].strip!
-            if field[0] == 'name'
-                name = field[1]
-            elsif field[0] == 'info'
-                info = field[1]
-            elsif field[0] == 'affected'
-                affected = field[1]
-            end
-            # Only show the error if the flag was not in the request's asana-enable header
-            if !(accounted_for_flags.include? name) && (affected == 'true')
-              message1 = 'This request is affected by the "%s"' +
-              ' deprecation. Please visit this url for more info: %s'
-              message2 = 'Adding "%s" to your "Asana-Enable" or ' +
-              '"Asana-Disable" header will opt in/out to this deprecation ' +
-              'and suppress this warning.'
-              STDERR.puts format(message1, name, info)
-              STDERR.puts format(message2, name)
-            end
+      changes.each do |unsplit_change|
+        change = unsplit_change.split(';')
+        name = nil
+        info = nil
+        affected = nil
+        change.each do |unsplit_field|
+          field = unsplit_field.split('=')
+          field[0].strip!
+          field[1].strip!
+          case field[0]
+          when 'name'
+            name = field[1]
+          when 'info'
+            info = field[1]
+          when 'affected'
+            affected = field[1]
           end
+          # Only show the error if the flag was not in the request's asana-enable header
+          next unless !(accounted_for_flags.include? name) && (affected == 'true')
+          message1 = 'This request is affected by the "%s" ' \
+                     'deprecation. Please visit this url for more info: %s'
+          message2 = 'Adding "%s" to your "Asana-Enable" or ' \
+                     '"Asana-Disable" header will opt in/out to this deprecation ' \
+                     'and suppress this warning.'
+          warn format(message1, name, info)
+          warn format(message2, name)
         end
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/asana/resource_includes/attachment_uploading.rb CHANGED Viewed

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+require 'faraday/multipart'
 module Asana
   module Resources
     # Internal: Mixin to add the ability to upload an attachment to a specific
@@ -11,8 +15,6 @@ module Asana
       # options  - [Hash] the request I/O options
       # data     - [Hash] extra attributes to post
       #
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
       def attach(filename: required('filename'),
                  mime: required('mime'),
                  io: nil, options: {}, **data)
@@ -21,9 +23,9 @@ module Asana
                    path = File.expand_path(filename)
                    raise ArgumentError, "file #{filename} doesn't exist" unless File.exist?(path)
-                   Faraday::FilePart.new(path, mime)
+                   Faraday::Multipart::FilePart.new(path, mime)
                  else
-                   Faraday::FilePart.new(io, mime, filename)
+                   Faraday::Multipart::FilePart.new(io, mime, filename)
                  end
         response = client.post("/#{self.class.plural_name}/#{gid}/attachments",
@@ -33,8 +35,6 @@ module Asana
         Attachment.new(parse(response).first, client: client)
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/asana/resource_includes/collection.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 require_relative 'response_helper'
 module Asana
@@ -40,7 +42,7 @@ module Asana
       def last
         @elements.last
       end
       # Public: Returns the size of the collection.
       def size
         to_a.size
@@ -49,9 +51,7 @@ module Asana
       # Public: Returns a String representation of the collection.
       def to_s
-        "#<Asana::Collection<#{@type}> " \
-          "[#{@elements.map(&:inspect).join(', ')}" +
-          (@next_page_data ? ', ...' : '') + ']>'
+        "#<Asana::Collection<#{@type}> [#{@elements.map(&:inspect).join(', ')}#{@next_page_data ? ', ...' : ''}]>"
       end
       alias inspect to_s

data/lib/asana/resource_includes/event.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 require_relative 'events'
 module Asana

data/lib/asana/resource_includes/event_subscription.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 require_relative 'events'
 module Asana

data/lib/asana/resource_includes/events.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 require_relative 'event'
 module Asana
@@ -89,13 +91,14 @@ module Asana
       # Internal: Returns the formatted params for the poll request.
       def params
-        { resource: @resource, sync: @sync }.reject { |_, v| v.nil? }
+        { resource: @resource, sync: @sync }.compact
       end
       # Internal: Executes a block if at least @wait seconds have passed since
       # @last_poll.
       def rate_limiting
         return if @last_poll && Time.now - @last_poll <= @wait
         yield.tap { @last_poll = Time.now }
       end
     end

data/lib/asana/resource_includes/registry.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 require_relative 'resource'
 require 'set'

data/lib/asana/resource_includes/resource.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 require_relative 'registry'
 require_relative 'response_helper'
@@ -21,6 +23,7 @@ module Asana
       def refresh
         raise "#{self.class.name} does not respond to #find_by_id" unless \
           self.class.respond_to?(:find_by_id)
         self.class.find_by_id(client, gid)
       end
@@ -30,17 +33,17 @@ module Asana
       # Returns the value for the requested property.
       #
       # Raises a NoMethodError if the property doesn't exist.
-      def method_missing(m, *args)
-        super unless respond_to_missing?(m, *args)
-        cache(m, wrapped(to_h[m.to_s]))
+      def method_missing(method_name, *args)
+        super unless respond_to_missing?(method_name, *args)
+        cache(method_name, wrapped(to_h[method_name.to_s]))
       end
       # Internal: Guard for the method_missing proxy. Checks if the resource
       # actually has a specific piece of data at all.
       #
       # Returns true if the resource has the property, false otherwise.
-      def respond_to_missing?(m, *)
-        to_h.key?(m.to_s)
+      def respond_to_missing?(method_name, *)
+        to_h.key?(method_name.to_s)
       end
       # Public:

data/lib/asana/resource_includes/response_helper.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 module Asana
   module Resources
     # Internal: A helper to make response body parsing easier.

data/lib/asana/resources/audit_log_api.rb ADDED Viewed

@@ -0,0 +1,42 @@
+require_relative 'gen/audit_log_api_base'
+module Asana
+  module Resources
+    class AuditLogAPI < AuditLogAPIBase
+      attr_reader :gid
+      attr_reader :actor
+      attr_reader :context
+      attr_reader :api_authentication_method
+      attr_reader :client_ip_address
+      attr_reader :context_type
+      attr_reader :oauth_app_name
+      attr_reader :user_agent
+      attr_reader :created_at
+      attr_reader :details
+      attr_reader :event_category
+      attr_reader :event_type
+      attr_reader :resource
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'audit_log_apis'
+        end
+      end
+    end
+  end
+end

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

@@ -36,18 +36,19 @@ module Asana
           Attachment.new(parse(client.get(path, options: options)).first, client: client)
         end
-        # Get attachments for a task
+        # Get attachments from an object
         #
-        # task_gid - [str]  (required) The task to operate on.
+        # parent - [str]  (required) Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`.
         # 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)
+        def get_attachments_for_object(client, parent: nil, options: {})
+          path = "/attachments"
+          params = { parent: parent }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get(path, params: params, options: options)), type: Attachment, client: client)
         end
       end

data/lib/asana/resources/gen/audit_log_api_base.rb ADDED Viewed

@@ -0,0 +1,37 @@
+### 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 AuditLogAPIBase < Resource
+      def self.inherited(base)
+        Registry.register(base)
+      end
+      class << self
+        # Get audit log events
+        #
+        # workspace_gid - [str]  (required) Globally unique identifier for the workspace or organization.
+        # start_at - [datetime]  Filter to events created after this time (inclusive).
+        # end_at - [datetime]  Filter to events created before this time (exclusive).
+        # event_type - [str]  Filter to events of this type. Refer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values.
+        # actor_type - [str]  Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded.
+        # actor_gid - [str]  Filter to events triggered by the actor with this ID.
+        # resource_gid - [str]  Filter to events with this resource ID.
+        # 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.
+        def get_audit_log_events(client, workspace_gid: required("workspace_gid"), start_at: nil, end_at: nil, event_type: nil, actor_type: nil, actor_gid: nil, resource_gid: nil, options: {})
+          path = "/workspaces/{workspace_gid}/audit_log_events"
+          path["{workspace_gid}"] = workspace_gid
+          params = { start_at: start_at, end_at: end_at, event_type: event_type, actor_type: actor_type, actor_gid: actor_gid, resource_gid: resource_gid }.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

data/lib/asana/resources/gen/goal_relationships_base.rb ADDED Viewed

@@ -0,0 +1,83 @@
+### 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 GoalRelationshipsBase < Resource
+      def self.inherited(base)
+        Registry.register(base)
+      end
+      class << self
+        # Add a supporting goal relationship
+        #
+        # goal_gid - [str]  (required) Globally unique identifier for the goal.
+        # 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_supporting_relationship(client, goal_gid: required("goal_gid"), options: {}, **data)
+          path = "/goals/{goal_gid}/addSupportingRelationship"
+          path["{goal_gid}"] = goal_gid
+          parse(client.post(path, body: data, options: options)).first
+        end
+        # Get a goal relationship
+        #
+        # goal_relationship_gid - [str]  (required) Globally unique identifier for the goal relationship.
+        # 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_goal_relationship(client, goal_relationship_gid: required("goal_relationship_gid"), options: {})
+          path = "/goal_relationships/{goal_relationship_gid}"
+          path["{goal_relationship_gid}"] = goal_relationship_gid
+          parse(client.get(path, options: options)).first
+        end
+        # Get goal relationships
+        #
+        # supported_goal - [str]  (required) Globally unique identifier for the supported goal in the goal relationship.
+        # resource_subtype - [str]  If provided, filter to goal relationships with a given resource_subtype.
+        # 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_goal_relationships(client, supported_goal: nil, resource_subtype: nil, options: {})
+          path = "/goal_relationships"
+          params = { supported_goal: supported_goal, resource_subtype: resource_subtype }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get(path, params: params, options: options)), type: Resource, client: client)
+        end
+        # Removes a supporting goal relationship
+        #
+        # goal_gid - [str]  (required) Globally unique identifier for the goal.
+        # 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_supporting_relationship(client, goal_gid: required("goal_gid"), options: {}, **data)
+          path = "/goals/{goal_gid}/removeSupportingRelationship"
+          path["{goal_gid}"] = goal_gid
+          parse(client.post(path, body: data, options: options)).first
+        end
+        # Update a goal relationship
+        #
+        # goal_relationship_gid - [str]  (required) Globally unique identifier for the goal relationship.
+        # 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_goal_relationship(client, goal_relationship_gid: required("goal_relationship_gid"), options: {}, **data)
+          path = "/goal_relationships/{goal_relationship_gid}"
+          path["{goal_relationship_gid}"] = goal_relationship_gid
+          parse(client.put(path, body: data, options: options)).first
+        end
+      end
+    end
+  end
+end