MailchimpMarketing 3.0.1

data/lib/MailchimpMarketing/api/templates_api.rb

@@ -0,0 +1,331 @@
+=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 TemplatesApi
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+    # Delete a specific template
+    # Delete a specific template.
+    # @param template_id The unique id for the template.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_template(template_id = {}, opts = {})
+      delete_template_with_http_info(template_id, opts)
+      nil
+    end
+
+    # Delete a specific template
+    # Delete a specific template.
+    # @param template_id The unique id for the template.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_template_with_http_info(template_id, opts = {})
+      # resource path
+      local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)
+
+      # 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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      return data, status_code, headers
+    end
+    # Get all templates
+    # Get a list of an account's available templates.
+    # @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] :created_by The Mailchimp account user who created the template.
+    # @option opts [String] :since_created_at Restrict the response to templates created after the set date. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
+    # @option opts [String] :before_created_at Restrict the response to templates created before the set date. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
+    # @option opts [String] :type Limit results based on template type.
+    # @option opts [String] :category Limit results based on category.
+    # @option opts [String] :folder_id The unique folder id.
+    # @option opts [String] :sort_field Returns user templates sorted by the specified field.
+    # @return [Templates]
+    def list(opts = {})
+      data, _status_code, _headers = list_with_http_info(opts)
+      data
+    end
+
+    # Get all templates
+    # Get a list of an account&#39;s available templates.
+    # @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] :created_by The Mailchimp account user who created the template.
+    # @option opts [String] :since_created_at Restrict the response to templates created after the set date. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
+    # @option opts [String] :before_created_at Restrict the response to templates created before the set date. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
+    # @option opts [String] :type Limit results based on template type.
+    # @option opts [String] :category Limit results based on category.
+    # @option opts [String] :folder_id The unique folder id.
+    # @option opts [String] :sort_field Returns user templates sorted by the specified field.
+    # @return [Array<(Templates, Fixnum, Hash)>] Templates data, response status code and response headers
+    def list_with_http_info(opts = {})
+      # resource path
+      local_var_path = '/templates'
+
+      # 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[:'created_by'] = opts[:'created_by'] if !opts[:'created_by'].nil?
+      query_params[:'since_created_at'] = opts[:'since_created_at'] if !opts[:'since_created_at'].nil?
+      query_params[:'before_created_at'] = opts[:'before_created_at'] if !opts[:'before_created_at'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
+      query_params[:'folder_id'] = opts[:'folder_id'] if !opts[:'folder_id'].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 => 'Templates')
+      return data, status_code, headers
+    end
+    # Get information about a specific template
+    # Get information about a specific template.
+    # @param template_id The unique id for the template.
+    # @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 [TemplateInstance]
+    def get_template(template_id = {}, opts = {})
+      data, _status_code, _headers = get_template_with_http_info(template_id, opts)
+      data
+    end
+
+    # Get information about a specific template
+    # Get information about a specific template.
+    # @param template_id The unique id for the template.
+    # @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<(TemplateInstance, Fixnum, Hash)>] TemplateInstance data, response status code and response headers
+    def get_template_with_http_info(template_id, opts = {})
+      # resource path
+      local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_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 => 'TemplateInstance')
+      return data, status_code, headers
+    end
+    # Get the default content for a template
+    # Get the sections that you can edit in a template, including each section's default content.
+    # @param template_id The unique id for the template.
+    # @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 [TemplateDefaultContent]
+    def get_default_content_for_template(template_id = {}, opts = {})
+      data, _status_code, _headers = get_default_content_for_template_with_http_info(template_id, opts)
+      data
+    end
+
+    # Get the default content for a template
+    # Get the sections that you can edit in a template, including each section&#39;s default content.
+    # @param template_id The unique id for the template.
+    # @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<(TemplateDefaultContent, Fixnum, Hash)>] TemplateDefaultContent data, response status code and response headers
+    def get_default_content_for_template_with_http_info(template_id, opts = {})
+      # resource path
+      local_var_path = '/templates/{template_id}/default-content'.sub('{' + 'template_id' + '}', template_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 => 'TemplateDefaultContent')
+      return data, status_code, headers
+    end
+    # Update an existing template
+    # Update the name, HTML, or `folder_id` of an existing template.
+    # @param template_id The unique id for the template.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [TemplateInstance]
+    def update_template(template_id = {}, body = {}, opts = {})
+      data, _status_code, _headers = update_template_with_http_info(template_id, body, opts)
+      data
+    end
+
+    # Update an existing template
+    # Update the name, HTML, or &#x60;folder_id&#x60; of an existing template.
+    # @param template_id The unique id for the template.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TemplateInstance, Fixnum, Hash)>] TemplateInstance data, response status code and response headers
+    def update_template_with_http_info(template_id, body, opts = {})
+      # resource path
+      local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)
+
+      # 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 = @api_client.object_to_http_body(body)
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TemplateInstance')
+      return data, status_code, headers
+    end
+    # Create a new template
+    # Create a new template for the account. Only [Classic templates](https://mailchimp.com/help/types-of-templates/) are supported.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [TemplateInstance]
+    def create(body = {}, opts = {})
+      data, _status_code, _headers = create_with_http_info(body, opts)
+      data
+    end
+
+    # Create a new template
+    # Create a new template for the account. Only [Classic templates](https://mailchimp.com/help/types-of-templates/) are supported.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TemplateInstance, Fixnum, Hash)>] TemplateInstance data, response status code and response headers
+    def create_with_http_info(body, opts = {})
+      # resource path
+      local_var_path = '/templates'
+
+      # 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 = @api_client.object_to_http_body(body)
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TemplateInstance')
+      return data, status_code, headers
+    end
+  end
+end

data/lib/MailchimpMarketing/api/verified_domains_api.rb

@@ -0,0 +1,242 @@
+=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 VerifiedDomainsApi
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+    # Add a domain to the account, triggering a verification e-mail to the provided address.
+    # Add a domain to the account.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [VerifiedDomains]
+    def create_verified_domain(body = {}, opts = {})
+      data, _status_code, _headers = create_verified_domain_with_http_info(body, opts)
+      data
+    end
+
+    # Add a domain to the account, triggering a verification e-mail to the provided address.
+    # Add a domain to the account.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VerifiedDomains, Fixnum, Hash)>] VerifiedDomains data, response status code and response headers
+    def create_verified_domain_with_http_info(body, opts = {})
+      # resource path
+      local_var_path = '/verified-domains'
+
+      # 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 = @api_client.object_to_http_body(body)
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'VerifiedDomains')
+      return data, status_code, headers
+    end
+    # Delete a verified domain
+    # Delete a verified domain from the account.
+    # @param domain_name The domain to be verified.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_domain(domain_name = {}, opts = {})
+      delete_domain_with_http_info(domain_name, opts)
+      nil
+    end
+
+    # Delete a verified domain
+    # Delete a verified domain from the account.
+    # @param domain_name The domain to be verified.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_domain_with_http_info(domain_name, opts = {})
+      # resource path
+      local_var_path = '/verified-domains/{domain_name}'.sub('{' + 'domain_name' + '}', domain_name.to_s)
+
+      # 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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      return data, status_code, headers
+    end
+    # Get the details for a single domain on the account.
+    # Get the details for a single domain on the account.
+    # @param domain_name The domain to be verified.
+    # @param [Hash] opts the optional parameters
+    # @return [VerifiedDomains]
+    def get_domain(domain_name = {}, opts = {})
+      data, _status_code, _headers = get_domain_with_http_info(domain_name, opts)
+      data
+    end
+
+    # Get the details for a single domain on the account.
+    # Get the details for a single domain on the account.
+    # @param domain_name The domain to be verified.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VerifiedDomains, Fixnum, Hash)>] VerifiedDomains data, response status code and response headers
+    def get_domain_with_http_info(domain_name, opts = {})
+      # resource path
+      local_var_path = '/verified-domains/{domain_name}'.sub('{' + 'domain_name' + '}', domain_name.to_s)
+
+      # 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 => 'VerifiedDomains')
+      return data, status_code, headers
+    end
+    # Get all of the sending domains on the account.
+    # Get all of the sending domains on the account.
+    # @param [Hash] opts the optional parameters
+    # @return [VerifiedDomains1]
+    def get_verified_domains_all(opts = {})
+      data, _status_code, _headers = get_verified_domains_all_with_http_info(opts)
+      data
+    end
+
+    # Get all of the sending domains on the account.
+    # Get all of the sending domains on the account.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VerifiedDomains1, Fixnum, Hash)>] VerifiedDomains1 data, response status code and response headers
+    def get_verified_domains_all_with_http_info(opts = {})
+      # resource path
+      local_var_path = '/verified-domains'
+
+      # 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 => 'VerifiedDomains1')
+      return data, status_code, headers
+    end
+    # Submit a response to the verification challenge and verify a domain for sending.
+    # Verify a domain for sending.
+    # @param domain_name The domain to be verified.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [VerifiedDomains]
+    def submit_domain_verification(domain_name = {}, body = {}, opts = {})
+      data, _status_code, _headers = submit_domain_verification_with_http_info(domain_name, body, opts)
+      data
+    end
+
+    # Submit a response to the verification challenge and verify a domain for sending.
+    # Verify a domain for sending.
+    # @param domain_name The domain to be verified.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VerifiedDomains, Fixnum, Hash)>] VerifiedDomains data, response status code and response headers
+    def submit_domain_verification_with_http_info(domain_name, body, opts = {})
+      # resource path
+      local_var_path = '/verified-domains/{domain_name}/actions/verify'.sub('{' + 'domain_name' + '}', domain_name.to_s)
+
+      # 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 = @api_client.object_to_http_body(body)
+      auth_names = ['basicAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'VerifiedDomains')
+      return data, status_code, headers
+    end
+  end
+end