MailchimpMarketing 3.0.1

data/lib/MailchimpMarketing/api/ping_api.rb

@@ -0,0 +1,65 @@
+=begin
+#Mailchimp Marketing API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 3.0.1
+Contact: apihelp@mailchimp.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'uri'
+
+module MailchimpMarketing
+  class PingApi
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+    # Ping the API
+    # A health check for the API that won't return any account-specific information.
+    # @param [Hash] opts the optional parameters
+    # @return [APIHealthStatus]
+    def get(opts = {})
+      data, _status_code, _headers = get_with_http_info(opts)
+      data
+    end
+
+    # Ping the API
+    # A health check for the API that won't return any account-specific information.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(APIHealthStatus, Fixnum, Hash)>] APIHealthStatus data, response status code and response headers
+    def get_with_http_info(opts = {})
+      # resource path
+      local_var_path = '/ping'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'APIHealthStatus')
+      return data, status_code, headers
+    end
+  end
+end

data/lib/MailchimpMarketing/api/postcards_api.rb

@@ -0,0 +1,77 @@
+=begin
+#Mailchimp Marketing API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 3.0.1
+Contact: apihelp@mailchimp.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'uri'
+
+module MailchimpMarketing
+  class PostcardsApi
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+    # __summary__
+    # Get all of a user's postcards.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :sort_dir Determines the order direction for sorted results.
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000** (default to 10)
+    # @return [InlineResponse2007]
+    def get_all(opts = {})
+      data, _status_code, _headers = get_all_with_http_info(opts)
+      data
+    end
+
+    # __summary__
+    # Get all of a user&#39;s postcards.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :sort_dir Determines the order direction for sorted results.
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000**
+    # @return [Array<(InlineResponse2007, Fixnum, Hash)>] InlineResponse2007 data, response status code and response headers
+    def get_all_with_http_info(opts = {})
+      # resource path
+      local_var_path = '/postcards'
+
+      # query parameters
+      query_params = {}
+      query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].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?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse2007')
+      return data, status_code, headers
+    end
+  end
+end

data/lib/MailchimpMarketing/api/reporting_api.rb

@@ -0,0 +1,338 @@
+=begin
+#Mailchimp Marketing API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 3.0.1
+Contact: apihelp@mailchimp.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'uri'
+
+module MailchimpMarketing
+  class ReportingApi
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+    # Get information about the reporting endpoint's resources
+    # Get information about the reporting endpoint's resources
+    # @param [Hash] opts the optional parameters
+    # @return [Reporting]
+    def info(opts = {})
+      data, _status_code, _headers = info_with_http_info(opts)
+      data
+    end
+
+    # Get information about the reporting endpoint's resources
+    # Get information about the reporting endpoint's resources
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Reporting, Fixnum, Hash)>] Reporting data, response status code and response headers
+    def info_with_http_info(opts = {})
+      # resource path
+      local_var_path = '/reporting'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Reporting')
+      return data, status_code, headers
+    end
+    # __summary__
+    # Get reports of Facebook Ads
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000** (default to 10)
+    # @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.  [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**. (default to 0)
+    # @option opts [String] :sort_field Returns files sorted by the specified field.
+    # @option opts [String] :sort_dir Determines the order direction for sorted results.
+    # @return [InlineResponse20011]
+    def get_facebook_ads_report_all(opts = {})
+      data, _status_code, _headers = get_facebook_ads_report_all_with_http_info(opts)
+      data
+    end
+
+    # __summary__
+    # Get reports of Facebook Ads
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000**
+    # @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.  [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**.
+    # @option opts [String] :sort_field Returns files sorted by the specified field.
+    # @option opts [String] :sort_dir Determines the order direction for sorted results.
+    # @return [Array<(InlineResponse20011, Fixnum, Hash)>] InlineResponse20011 data, response status code and response headers
+    def get_facebook_ads_report_all_with_http_info(opts = {})
+      # resource path
+      local_var_path = '/reporting/facebook-ads'
+
+      # query parameters
+      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?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
+      query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20011')
+      return data, status_code, headers
+    end
+    # __summary__
+    # Get report of a facebook ad
+    # @param outreach_id The outreach id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @return [InlineResponse20012]
+    def get_facebook_ad_report(outreach_id = {}, opts = {})
+      data, _status_code, _headers = get_facebook_ad_report_with_http_info(outreach_id, opts)
+      data
+    end
+
+    # __summary__
+    # Get report of a facebook ad
+    # @param outreach_id The outreach id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @return [Array<(InlineResponse20012, Fixnum, Hash)>] InlineResponse20012 data, response status code and response headers
+    def get_facebook_ad_report_with_http_info(outreach_id, opts = {})
+      # resource path
+      local_var_path = '/reporting/facebook-ads/{outreach_id}'.sub('{' + 'outreach_id' + '}', outreach_id.to_s)
+
+      # query parameters
+      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?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20012')
+      return data, status_code, headers
+    end
+    # __summary__
+    # Get breakdown of product activity for an outreach
+    # @param outreach_id The outreach id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000** (default to 10)
+    # @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.  [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**. (default to 0)
+    # @option opts [String] :sort_field Returns files sorted by the specified field.
+    # @return [InlineResponse2008]
+    def get_facebook_ad_product_activity_report(outreach_id = {}, opts = {})
+      data, _status_code, _headers = get_facebook_ad_product_activity_report_with_http_info(outreach_id, opts)
+      data
+    end
+
+    # __summary__
+    # Get breakdown of product activity for an outreach
+    # @param outreach_id The outreach id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000**
+    # @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.  [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**.
+    # @option opts [String] :sort_field Returns files sorted by the specified field.
+    # @return [Array<(InlineResponse2008, Fixnum, Hash)>] InlineResponse2008 data, response status code and response headers
+    def get_facebook_ad_product_activity_report_with_http_info(outreach_id, opts = {})
+      # resource path
+      local_var_path = '/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity'.sub('{' + 'outreach_id' + '}', outreach_id.to_s)
+
+      # query parameters
+      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?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse2008')
+      return data, status_code, headers
+    end
+    # __summary__
+    # Get reports of Landing Pages
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000** (default to 10)
+    # @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.  [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**. (default to 0)
+    # @return [InlineResponse20013]
+    def get_landing_page_reports_all(opts = {})
+      data, _status_code, _headers = get_landing_page_reports_all_with_http_info(opts)
+      data
+    end
+
+    # __summary__
+    # Get reports of Landing Pages
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000**
+    # @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.  [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**.
+    # @return [Array<(InlineResponse20013, Fixnum, Hash)>] InlineResponse20013 data, response status code and response headers
+    def get_landing_page_reports_all_with_http_info(opts = {})
+      # resource path
+      local_var_path = '/reporting/landing-pages'
+
+      # query parameters
+      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?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20013')
+      return data, status_code, headers
+    end
+    # __summary__
+    # Get report of a landing page
+    # @param outreach_id The outreach id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @return [LandingPageReport]
+    def get_landing_page_report(outreach_id = {}, opts = {})
+      data, _status_code, _headers = get_landing_page_report_with_http_info(outreach_id, opts)
+      data
+    end
+
+    # __summary__
+    # Get report of a landing page
+    # @param outreach_id The outreach id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
+    # @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
+    # @return [Array<(LandingPageReport, Fixnum, Hash)>] LandingPageReport data, response status code and response headers
+    def get_landing_page_report_with_http_info(outreach_id, opts = {})
+      # resource path
+      local_var_path = '/reporting/landing-pages/{outreach_id}'.sub('{' + 'outreach_id' + '}', outreach_id.to_s)
+
+      # query parameters
+      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?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'LandingPageReport')
+      return data, status_code, headers
+    end
+  end
+end