class DataSift::AccountIdentityLimit

Class for accessing DataSift's Account API Identity Limits

Public Instance Methods

create(identity_id = '', service = '', total_allowance = nil, analyze_queries = nil) click to toggle source

Creates a Limit for an Identity

@param identity_id [String] ID of the Identity for which you are creating

a limit

@param service [String] The service this limit will apply to. For example;

'facebook'

@param total_allowance [Integer] (Optional) The daily interaction limit for this Identity @param analyze_queries [Integer] (Optional) The hourly analysis query limit for this Identity @return [Object] API reponse object

# File lib/account_identity_limit.rb, line 14
def create(identity_id = '', service = '', total_allowance = nil, analyze_queries = nil)
  fail BadParametersError, 'identity_id is required' if identity_id.empty?
  fail BadParametersError, 'service is required' if service.empty?
  fail BadParametersError, 'Must set total_allowance or analyze_queries' if
    total_allowance.nil? && analyze_queries.nil?
  params = { service: service }
  params[:total_allowance] = total_allowance unless total_allowance.nil?
  params[:analyze_queries] = analyze_queries unless analyze_queries.nil?

  DataSift.request(:POST, "account/identity/#{identity_id}/limit", @config, params)
end
delete(identity_id = '', service = '') click to toggle source

Removes a Service Limit for an Identity

@param identity_id [String] ID of the Identity for which you wish to

remove the Limit

@param service [String] Service from which you wish to remove the Limit @return [Object] API response object

# File lib/account_identity_limit.rb, line 83
def delete(identity_id = '', service = '')
  fail BadParametersError, 'identity_id is required' if identity_id.empty?
  fail BadParametersError, 'service is required' if service.empty?

  DataSift.request(:DELETE, "account/identity/#{identity_id}/limit/#{service}", @config)
end
get(identity_id = '', service = '') click to toggle source

Get the Limit for a given Identity and Service

@param identity_id [String] ID of the Identity you wish to return limits

for

@param service [String] Name of the service you are retreiving limits for @return [Object] API reponse object

# File lib/account_identity_limit.rb, line 32
def get(identity_id = '', service = '')
  fail BadParametersError, 'identity_id is required' if identity_id.empty?
  fail BadParametersError, 'service is required' if service.empty?

  DataSift.request(:GET, "account/identity/#{identity_id}/limit/#{service}", @config)
end
list(service = '', per_page = '', page = '') click to toggle source

Returns a list Identities and their Limits for a given Service

@param service [String] ID of the Identity we are fetching Limits for @param per_page [Integer] (Optional) How many Identities and Limits should

be returned per page of results

@param page [Integer] (Optional) Which page of results to return @return [Object] API reponse object

# File lib/account_identity_limit.rb, line 46
def list(service = '', per_page = '', page = '')
  fail BadParametersError, 'service is required' if service.empty?

  params = {}
  params[:per_page] = per_page unless per_page.empty?
  params[:page] = page unless page.empty?

  DataSift.request(:GET, "account/identity/limit/#{service}", @config, params)
end
update(identity_id = '', service = '', total_allowance = nil, analyze_queries = nil) click to toggle source

Updates a Limit for an Identity by Service

@param identity_id [String] ID of the Identity for which you are updating

a limit

@param service [String] The service this limit will apply to. For example;

'facebook'

@param total_allowance [Integer] (Optional) The daily interaction limit for this Identity @param analyze_queries [Integer] (Optional) The hourly analysis query limit for this Identity @return [Object] API reponse object

# File lib/account_identity_limit.rb, line 65
def update(identity_id = '', service = '', total_allowance = nil, analyze_queries = nil)
  fail BadParametersError, 'identity_id is required' if identity_id.empty?
  fail BadParametersError, 'service is required' if service.empty?
  fail BadParametersError, 'Must set total_allowance or analyze_queries' if
    total_allowance.nil? && analyze_queries.nil?
  params = {}
  params[:total_allowance] = total_allowance unless total_allowance.nil?
  params[:analyze_queries] = analyze_queries unless analyze_queries.nil?

  DataSift.request(:PUT, "account/identity/#{identity_id}/limit/#{service}", @config, params)
end