MailchimpMarketing 3.0.1

data/lib/MailchimpMarketing/api/root_api.rb

@@ -0,0 +1,71 @@
+=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 RootApi
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+    # API Root
+    # Get links to all other resources available in the API.
+    # @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 [APIRoot]
+    def get_root(opts = {})
+      data, _status_code, _headers = get_root_with_http_info(opts)
+      data
+    end
+
+    # API Root
+    # Get links to all other resources available in the API.
+    # @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<(APIRoot, Fixnum, Hash)>] APIRoot data, response status code and response headers
+    def get_root_with_http_info(opts = {})
+      # resource path
+      local_var_path = '/'
+
+      # 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 => 'APIRoot')
+      return data, status_code, headers
+    end
+  end
+end

data/lib/MailchimpMarketing/api/search_campaigns_api.rb

@@ -0,0 +1,74 @@
+=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 SearchCampaignsApi
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+    # Search Campaigns
+    # Search all campaigns for the specified query terms.
+    # @param query The search query used to filter results.
+    # @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 [Campaigns]
+    def search(query = {}, opts = {})
+      data, _status_code, _headers = search_with_http_info(query, opts)
+      data
+    end
+
+    # Search Campaigns
+    # Search all campaigns for the specified query terms.
+    # @param query The search query used to filter results.
+    # @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<(Campaigns, Fixnum, Hash)>] Campaigns data, response status code and response headers
+    def search_with_http_info(query, opts = {})
+      # resource path
+      local_var_path = '/search-campaigns'
+
+      # query parameters
+      query_params = {}
+      query_params[:'query'] = query
+      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 => 'Campaigns')
+      return data, status_code, headers
+    end
+  end
+end

data/lib/MailchimpMarketing/api/search_members_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 SearchMembersApi
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+    # Search Members
+    # Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account.
+    # @param query The search query used to filter results.
+    # @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 [String] :list_id The unique id for the list.
+    # @return [Members]
+    def search(query = {}, opts = {})
+      data, _status_code, _headers = search_with_http_info(query, opts)
+      data
+    end
+
+    # Search Members
+    # Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account.
+    # @param query The search query used to filter results.
+    # @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 [String] :list_id The unique id for the list.
+    # @return [Array<(Members, Fixnum, Hash)>] Members data, response status code and response headers
+    def search_with_http_info(query, opts = {})
+      # resource path
+      local_var_path = '/search-members'
+
+      # query parameters
+      query_params = {}
+      query_params[:'query'] = query
+      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[:'list_id'] = opts[:'list_id'] if !opts[:'list_id'].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 => 'Members')
+      return data, status_code, headers
+    end
+  end
+end

data/lib/MailchimpMarketing/api/template_folders_api.rb

@@ -0,0 +1,260 @@
+=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 TemplateFoldersApi
+    attr_accessor :api_client
+
+    def initialize(api_client)
+      @api_client = api_client
+    end
+    # Delete a template folder
+    # Delete a specific template folder, and mark all the templates in the folder as 'unfiled'.
+    # @param folder_id The unique id for the template folder.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def remove(folder_id = {}, opts = {})
+      remove_with_http_info(folder_id, opts)
+      nil
+    end
+
+    # Delete a template folder
+    # Delete a specific template folder, and mark all the templates in the folder as 'unfiled'.
+    # @param folder_id The unique id for the template folder.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def remove_with_http_info(folder_id, opts = {})
+      # resource path
+      local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_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 template folders
+    # Get all folders used to organize 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)
+    # @return [TemplateFolders]
+    def list(opts = {})
+      data, _status_code, _headers = list_with_http_info(opts)
+      data
+    end
+
+    # Get all template folders
+    # Get all folders used to organize 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**.
+    # @return [Array<(TemplateFolders, Fixnum, Hash)>] TemplateFolders data, response status code and response headers
+    def list_with_http_info(opts = {})
+      # resource path
+      local_var_path = '/template-folders'
+
+      # 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 => 'TemplateFolders')
+      return data, status_code, headers
+    end
+    # Get a template folder
+    # Get information about a specific folder used to organize templates.
+    # @param folder_id The unique id for the template folder.
+    # @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 [TemplateFolder]
+    def get(folder_id = {}, opts = {})
+      data, _status_code, _headers = get_with_http_info(folder_id, opts)
+      data
+    end
+
+    # Get a template folder
+    # Get information about a specific folder used to organize templates.
+    # @param folder_id The unique id for the template folder.
+    # @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<(TemplateFolder, Fixnum, Hash)>] TemplateFolder data, response status code and response headers
+    def get_with_http_info(folder_id, opts = {})
+      # resource path
+      local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_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 => 'TemplateFolder')
+      return data, status_code, headers
+    end
+    # Update a template folder
+    # Update a specific folder used to organize templates.
+    # @param folder_id The unique id for the template folder.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [TemplateFolder]
+    def update(folder_id = {}, body = {}, opts = {})
+      data, _status_code, _headers = update_with_http_info(folder_id, body, opts)
+      data
+    end
+
+    # Update a template folder
+    # Update a specific folder used to organize templates.
+    # @param folder_id The unique id for the template folder.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TemplateFolder, Fixnum, Hash)>] TemplateFolder data, response status code and response headers
+    def update_with_http_info(folder_id, body, opts = {})
+      # resource path
+      local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_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 => 'TemplateFolder')
+      return data, status_code, headers
+    end
+    # Create a template folder
+    # Create a new template folder.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [TemplateFolder]
+    def create(body = {}, opts = {})
+      data, _status_code, _headers = create_with_http_info(body, opts)
+      data
+    end
+
+    # Create a template folder
+    # Create a new template folder.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TemplateFolder, Fixnum, Hash)>] TemplateFolder data, response status code and response headers
+    def create_with_http_info(body, opts = {})
+      # resource path
+      local_var_path = '/template-folders'
+
+      # 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 => 'TemplateFolder')
+      return data, status_code, headers
+    end
+  end
+end