Class: DataSift::ManagedSourceAuth

Inherits:

ApiResource

• Object
• ApiResource
• DataSift::ManagedSourceAuth

Defined in:

lib/managed_source_auth.rb

Overview

Methods for using Auth specific Managed Sources API endpoints

Constant Summary

Constants inherited from ApiResource

ApiResource::TLSv1, ApiResource::TLSv1_2

Constants included from DataSift

APPLICATION_JSON, DELETE, DETECT_DEAD_SOCKETS, GET, HEAD, IS_WINDOWS, KNOWN_SOCKETS, SOCKET_DETECTOR_TIMEOUT, VERSION, X_ANALYSIS_TASKS_QUEUED, X_ANALYSIS_TASKS_QUEUE_LIMIT, X_INSIGHT_TASKS_QUEUED, X_INSIGHT_TASKS_QUEUE_LIMIT, X_RATELIMIT_COST, X_RATELIMIT_LIMIT, X_RATELIMIT_REMAINING, X_TASKS_QUEUED, X_TASKS_QUEUE_LIMIT

Instance Method Summary

• #add(id, auth, validate = 'true') ⇒ Object

  Add auth tokens to a Managed Source.

• #remove(id, auth_ids) ⇒ Object

  Remove auth tokens from a Managed Source.

Methods inherited from ApiResource

#initialize, #requires

Methods included from DataSift

#build_path, request

Constructor Details

This class inherits a constructor from DataSift::ApiResource

Instance Method Details

#add(id, auth, validate = 'true') ⇒ Object

Add auth tokens to a Managed Source

Parameters:

• id (String) —

  ID of the Managed Source you are adding Auth tokens to

• auth (Array) —

  Array of auth tokens you are adding to your source

• validate (Boolean) (defaults to: 'true') —

  Whether you want to validate your new tokens against the third party API (i.e. the Facebook or Instagram API)

# File 'lib/managed_source_auth.rb', line 10

def add(id, auth, validate = 'true')
  params = {
    id: id,
    auth: auth,
    validate: validate
  }
  requires params
  DataSift.request(:PUT, 'source/auth/add', @config, params)
end

#remove(id, auth_ids) ⇒ Object

Remove auth tokens from a Managed Source

Parameters:

• id (String) —

  ID of the Managed Source you are removing auth tokens from

• auth_ids (Array) —

  Array of auth_id strings you need to remove from your source

# File 'lib/managed_source_auth.rb', line 26

def remove(id, auth_ids)
  params = {
    id: id,
    auth_ids: auth_ids
  }
  requires params
  DataSift.request(:PUT, 'source/auth/remove', @config, params)
end