Class: MailchimpMarketing::LandingPagesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ LandingPagesApi

Returns a new instance of LandingPagesApi.



19
20
21
 
# File 'lib/MailchimpMarketing/api/landing_pages_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/landing_pages_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(body, opts = {}) ⇒ Object

Add landing page



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/MailchimpMarketing/api/landing_pages_api.rb', line 106

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

  query_params = {}
  query_params[:'use_default_list'] = opts[:'use_default_list'] if !opts[:'use_default_list'].nil?
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/landing-pages'
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#delete_page(page_id, opts = {}) ⇒ Object

Delete landing page



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

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

  query_params = {}
  post_body = nil

  local_var_path = '/landing-pages/{page_id}'.sub('{' + 'page_id' + '}', page_id.to_s)
  data = @api_client.call_api(:DELETE, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_all(opts = {}) ⇒ Object

List landing pages



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/MailchimpMarketing/api/landing_pages_api.rb', line 38

def get_all(opts = {})
  fail ArgumentError, 'invalid value for "sort_dir", must be one of ASC, DESC' if opts[:'sort_dir'] && !['ASC', 'DESC'].include?(opts[:'sort_dir'])
  fail ArgumentError, 'invalid value for "sort_field", must be one of created_at, updated_at' if opts[:'sort_field'] && !['created_at', 'updated_at'].include?(opts[:'sort_field'])
  fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000

  query_params = {}
  query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
  query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  post_body = nil

  local_var_path = '/landing-pages'
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_page(page_id, opts = {}) ⇒ Object

Get landing page info



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/MailchimpMarketing/api/landing_pages_api.rb', line 59

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

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/landing-pages/{page_id}'.sub('{' + 'page_id' + '}', page_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#get_page_content(page_id, opts = {}) ⇒ Object

Get landing page content



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/MailchimpMarketing/api/landing_pages_api.rb', line 75

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

  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  post_body = nil

  local_var_path = '/landing-pages/{page_id}/content'.sub('{' + 'page_id' + '}', page_id.to_s)
  data = @api_client.call_api(:GET, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#publish_page(page_id, opts = {}) ⇒ Object

Publish landing page



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/MailchimpMarketing/api/landing_pages_api.rb', line 121

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

  query_params = {}
  post_body = nil

  local_var_path = '/landing-pages/{page_id}/actions/publish'.sub('{' + 'page_id' + '}', page_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#unpublish_page(page_id, opts = {}) ⇒ Object

Unpublish landing page



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/MailchimpMarketing/api/landing_pages_api.rb', line 135

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

  query_params = {}
  post_body = nil

  local_var_path = '/landing-pages/{page_id}/actions/unpublish'.sub('{' + 'page_id' + '}', page_id.to_s)
  data = @api_client.call_api(:POST, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end

#update_page(page_id, body, opts = {}) ⇒ Object

Update landing page



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/MailchimpMarketing/api/landing_pages_api.rb', line 91

def update_page(page_id, body, opts = {})
  fail ArgumentError, "Missing required param: 'page_id'" if page_id.nil?
  fail ArgumentError, "Missing required param: 'body'" if body.nil?

  query_params = {}
  post_body = @api_client.object_to_http_body(body)

  local_var_path = '/landing-pages/{page_id}'.sub('{' + 'page_id' + '}', page_id.to_s)
  data = @api_client.call_api(:PATCH, local_var_path,
    :query_params => query_params,
    :body => post_body)
  return data
end