Class: MailchimpMarketing::SurveysApi

Inherits:
Object
  • Object
show all
Defined in:
lib/MailchimpMarketing/api/surveys_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ SurveysApi

Returns a new instance of SurveysApi.



19
20
21
 
# File 'lib/MailchimpMarketing/api/surveys_api.rb', line 19

def initialize(api_client)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/MailchimpMarketing/api/surveys_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#publish_survey(list_id, survey_id, opts = {}) ⇒ Object

Publish a Survey



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/MailchimpMarketing/api/surveys_api.rb', line 24

def publish_survey(list_id, survey_id, opts = {})
  fail ArgumentError, "Missing required param: 'list_id'" if list_id.nil?
  fail ArgumentError, "Missing required param: 'survey_id'" if survey_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/lists/{list_id}/surveys/{survey_id}/actions/publish'.sub('{' + 'list_id' + '}', list_id.to_s).sub('{' + 'survey_id' + '}', survey_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#unpublish_survey(list_id, survey_id, opts = {}) ⇒ Object

Unpublish a Survey



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/MailchimpMarketing/api/surveys_api.rb', line 39

def unpublish_survey(list_id, survey_id, opts = {})
  fail ArgumentError, "Missing required param: 'list_id'" if list_id.nil?
  fail ArgumentError, "Missing required param: 'survey_id'" if survey_id.nil?

  query_params = {}
  post_body = nil

  local_var_path = '/lists/{list_id}/surveys/{survey_id}/actions/unpublish'.sub('{' + 'list_id' + '}', list_id.to_s).sub('{' + 'survey_id' + '}', survey_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end