Class: TalkboxApi::Surveys

Inherits:
Object
  • Object
show all
Defined in:
lib/talkbox_api/surveys.rb

Overview

Surveys resource class This class provides methods for interacting with the Talkbox API surveys resource.

Instance Method Summary collapse

Constructor Details

#initialize(conn) ⇒ Surveys

Returns a new instance of Surveys.



7
8
9
 
# File 'lib/talkbox_api/surveys.rb', line 7

def initialize(conn)
  @conn = conn
end

Instance Method Details

#all(params = nil) ⇒ Array

Retrieves all surveys

Parameters:

  • params (Hash) (defaults to: nil) —

    Optional parameters for the request

Returns:

  • (Array) —

    The list of surveys



14
15
16
 
# File 'lib/talkbox_api/surveys.rb', line 14

def all(params = nil)
  @conn.get("#{PATH_PREFIX}/surveys", params).body
end

#score(params = nil) ⇒ Hash

Retrieves the score of a survey

Parameters:

  • params (Hash) (defaults to: nil) —

    Optional parameters for the request

Returns:

  • (Hash) —

    The score of the survey



21
22
23
 
# File 'lib/talkbox_api/surveys.rb', line 21

def score(params = nil)
  @conn.get("#{PATH_PREFIX}/surveys/score", params).body
end