Module: Surveygizmo::Client::Survey

Included in:

Surveygizmo::Client

Defined in:

lib/surveygizmo/client/survey.rb

Overview

Defines methods related to a SurveyGizmo survey Polls, Quizzes, Forms, Registrations are all surveys with simple flags activated to change the behavior of the object

See Also:

• http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/api-object-survey/

Instance Method Summary

• #polls ⇒ Object

  Temporary, until SG implements filtering by subtype.

• #survey(id, metaonly = false) ⇒ Object

  Returns survey details for a given id.

• #surveys(options = {}) ⇒ Object

  List all surveys, optionally filtered.

Instance Method Details

#polls ⇒ Object

Temporary, until SG implements filtering by subtype

# File 'lib/surveygizmo/client/survey.rb', line 15

def polls
  surveys.select { |s| s._subtype == 'Poll' }
end

#survey(id, metaonly = false) ⇒ Object

Returns survey details for a given id

Parameters:

• id (Integer, String) —

  A SurveyGizmo AccountUser ID

• metaonly (Boolean) (defaults to: false) —

  Return only meta data

# File 'lib/surveygizmo/client/survey.rb', line 22

def survey(id, metaonly = false)
  get("survey/#{id}", :metaonly => metaonly)
end

#surveys(options = {}) ⇒ Object

List all surveys, optionally filtered

Parameters:

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

  Option(s) used to refine search

# File 'lib/surveygizmo/client/survey.rb', line 10

def surveys(options = {})
  get('survey', options)
end