class MailchimpMarketing::LandingPagesApi
Attributes
api_client[RW]
Public Class Methods
new(api_client)
click to toggle source
# File lib/MailchimpMarketing/api/landing_pages_api.rb, line 19 def initialize(api_client) @api_client = api_client end
Public Instance Methods
create(body, opts = {})
click to toggle source
Add landing page
# 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 = {})
click to toggle source
Delete landing page
# 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 = {})
click to toggle source
List landing pages
# 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 = {})
click to toggle source
Get landing page info
# 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 = {})
click to toggle source
Get landing page content
# 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 = {})
click to toggle source
Publish landing page
# 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 = {})
click to toggle source
Unpublish landing page
# 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 = {})
click to toggle source
Update landing page
# 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