Class: Platforms::Yammer::Api::Relationships

Inherits:

Base

• Object
• Base
• Platforms::Yammer::Api::Relationships

Defined in:

lib/platforms/yammer/api/relationships.rb

Overview

TODO:

confirm documentation, which currently (2020-03-25) is confused

Relationships in Yammer around parameters and mentions updating relationships as part of a GET request

Author:

• Benjamin Elias

Since:

• 0.1.0

Instance Method Summary

• #get(options = {}, headers = {}) ⇒ Faraday::Response

  Get relationships.

• #post(options = {}, headers = {}) ⇒ Faraday::Response

  Update relationships.

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from Platforms::Yammer::Api::Base

Instance Method Details

#get(options = {}, headers = {}) ⇒ Faraday::Response

Get relationships

Parameters:

• options (Hash) (defaults to: {}) —

  Options for the request

• headers (Hash) (defaults to: {}) —

  Additional headers to send with the request

Returns:

• (Faraday::Response) —

  the API response

See Also:

• https://developer.yammer.com/docs/relationshipsjson

Since:

• 0.1.0

# File 'lib/platforms/yammer/api/relationships.rb', line 18

def get options={}, headers={}
  @connection.get 'relationships.json', options, headers
end

#post(options = {}, headers = {}) ⇒ Faraday::Response

Update relationships

It is unclear how exactly this works with subordinates, and “all three can be passed in one request”.

Parameters:

• options (Hash) (defaults to: {}) —

  Options for the request body

• headers (Hash) (defaults to: {}) —

  Additional headers to send with the request

Returns:

• (Faraday::Response) —

  the API response

See Also:

• https://developer.yammer.com/docs/relationshipsjson-1

Since:

• 0.1.0

# File 'lib/platforms/yammer/api/relationships.rb', line 32

def post options={}, headers={}
  @connection.post 'relationships.json', options, headers
end