Class: Forem::Services::SurveyService

Inherits:
BaseService show all
Defined in:
lib/forem/services/survey_service.rb

Overview

Service for interacting with the Forem Surveys API.

Surveys are questionnaires presented to community members. Access via Client#surveys. All methods inject the client's requestor automatically so no additional configuration is required.

Examples:

client = Forem::Client.new("your-api-key")
surveys = client.surveys.list
survey  = client.surveys.retrieve(8)

See Also:

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

This class inherits a constructor from Forem::Services::BaseService

Instance Method Details

#list(params = {}, opts = {}) ⇒ Array<Survey>

List all surveys.

Examples:

client.surveys.list

Parameters:

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

    query parameters

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

    per-request options

Options Hash (params):

  • :page (Integer) —

    page number (default: 1)

  • :per_page (Integer) —

    number of results per page

Returns:

  • (Array<Survey>) —

    list of surveys

See Also:



29
30
31
 
# File 'lib/forem/services/survey_service.rb', line 29

def list(params = {}, opts = {})
  Survey.list(params, opts_with_requestor(opts))
end

#retrieve(id, opts = {}) ⇒ Survey

Retrieve a single survey by its numeric ID.

Examples:

client.surveys.retrieve(8)

Parameters:

  • id (Integer, String) —

    the survey ID

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

    per-request options

Returns:

  • (Survey) —

    the survey with the given ID

See Also:



43
44
45
 
# File 'lib/forem/services/survey_service.rb', line 43

def retrieve(id, opts = {})
  Survey.retrieve(id, opts_with_requestor(opts))
end