MailchimpTransactional 1.0.4

data/lib/MailchimpTransactional/api/rejects_api.rb

@@ -0,0 +1,116 @@
+=begin
+#Mailchimp Transactional API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.4
+Contact: apihelp@mandrill.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'uri'
+
+module MailchimpTransactional
+  class RejectsApi
+    attr_accessor :api_client
+
+    attr_accessor :api_key
+
+    def initialize(api_key = '', api_client = ApiClient.default)
+      @api_key = api_key
+      @api_client = api_client
+    end
+    # /rejects/add
+    # Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20037]
+    def add(body = {}, opts = {})
+      data, _status_code, _headers = add_with_http_info(body, opts)
+      data
+    end
+
+    # /rejects/add
+    # Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20037, Fixnum, Hash)>] InlineResponse20037 data, response status code and response headers
+    def add_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/rejects/add'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20037')
+      return data, status_code, headers
+    end
+    # /rejects/delete
+    # Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20039]
+    def delete(body = {}, opts = {})
+      data, _status_code, _headers = delete_with_http_info(body, opts)
+      data
+    end
+
+    # /rejects/delete
+    # Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20039, Fixnum, Hash)>] InlineResponse20039 data, response status code and response headers
+    def delete_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/rejects/delete'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20039')
+      return data, status_code, headers
+    end
+    # /rejects/list
+    # Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<InlineResponse20038>]
+    def list(body = {}, opts = {})
+      data, _status_code, _headers = list_with_http_info(body, opts)
+      data
+    end
+
+    # /rejects/list
+    # Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<InlineResponse20038>, Fixnum, Hash)>] Array<InlineResponse20038> data, response status code and response headers
+    def list_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/rejects/list'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'Array<InlineResponse20038>')
+      return data, status_code, headers
+    end
+  end
+end

data/lib/MailchimpTransactional/api/senders_api.rb

@@ -0,0 +1,236 @@
+=begin
+#Mailchimp Transactional API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.4
+Contact: apihelp@mandrill.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'uri'
+
+module MailchimpTransactional
+  class SendersApi
+    attr_accessor :api_client
+
+    attr_accessor :api_key
+
+    def initialize(api_key = '', api_client = ApiClient.default)
+      @api_key = api_key
+      @api_client = api_client
+    end
+    # /senders/add-domain
+    # Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20042]
+    def add_domain(body = {}, opts = {})
+      data, _status_code, _headers = add_domain_with_http_info(body, opts)
+      data
+    end
+
+    # /senders/add-domain
+    # Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20042, Fixnum, Hash)>] InlineResponse20042 data, response status code and response headers
+    def add_domain_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/senders/add-domain'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20042')
+      return data, status_code, headers
+    end
+    # /senders/check-domain
+    # Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your account, it will be added automatically.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20043]
+    def check_domain(body = {}, opts = {})
+      data, _status_code, _headers = check_domain_with_http_info(body, opts)
+      data
+    end
+
+    # /senders/check-domain
+    # Checks the SPF and DKIM settings for a domain. If you haven&#39;t already added this domain to your account, it will be added automatically.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20043, Fixnum, Hash)>] InlineResponse20043 data, response status code and response headers
+    def check_domain_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/senders/check-domain'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20043')
+      return data, status_code, headers
+    end
+    # /senders/domains
+    # Returns the sender domains that have been added to this account
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<InlineResponse20041>]
+    def domains(body = {}, opts = {})
+      data, _status_code, _headers = domains_with_http_info(body, opts)
+      data
+    end
+
+    # /senders/domains
+    # Returns the sender domains that have been added to this account
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<InlineResponse20041>, Fixnum, Hash)>] Array<InlineResponse20041> data, response status code and response headers
+    def domains_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/senders/domains'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'Array<InlineResponse20041>')
+      return data, status_code, headers
+    end
+    # /senders/info
+    # Return more detailed information about a single sender, including aggregates of recent stats
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20045]
+    def info(body = {}, opts = {})
+      data, _status_code, _headers = info_with_http_info(body, opts)
+      data
+    end
+
+    # /senders/info
+    # Return more detailed information about a single sender, including aggregates of recent stats
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20045, Fixnum, Hash)>] InlineResponse20045 data, response status code and response headers
+    def info_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/senders/info'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20045')
+      return data, status_code, headers
+    end
+    # /senders/list
+    # Return the senders that have tried to use this account
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<InlineResponse20040>]
+    def list(body = {}, opts = {})
+      data, _status_code, _headers = list_with_http_info(body, opts)
+      data
+    end
+
+    # /senders/list
+    # Return the senders that have tried to use this account
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<InlineResponse20040>, Fixnum, Hash)>] Array<InlineResponse20040> data, response status code and response headers
+    def list_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/senders/list'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'Array<InlineResponse20040>')
+      return data, status_code, headers
+    end
+    # /senders/time-series
+    # Return the recent history (hourly stats for the last 30 days) for a sender
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<InlineResponse20046>]
+    def time_series(body = {}, opts = {})
+      data, _status_code, _headers = time_series_with_http_info(body, opts)
+      data
+    end
+
+    # /senders/time-series
+    # Return the recent history (hourly stats for the last 30 days) for a sender
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<InlineResponse20046>, Fixnum, Hash)>] Array<InlineResponse20046> data, response status code and response headers
+    def time_series_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/senders/time-series'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'Array<InlineResponse20046>')
+      return data, status_code, headers
+    end
+    # /senders/verify-domain
+    # Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20044]
+    def verify_domain(body = {}, opts = {})
+      data, _status_code, _headers = verify_domain_with_http_info(body, opts)
+      data
+    end
+
+    # /senders/verify-domain
+    # Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20044, Fixnum, Hash)>] InlineResponse20044 data, response status code and response headers
+    def verify_domain_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/senders/verify-domain'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20044')
+      return data, status_code, headers
+    end
+  end
+end

data/lib/MailchimpTransactional/api/subaccounts_api.rb

@@ -0,0 +1,236 @@
+=begin
+#Mailchimp Transactional API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.4
+Contact: apihelp@mandrill.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'uri'
+
+module MailchimpTransactional
+  class SubaccountsApi
+    attr_accessor :api_client
+
+    attr_accessor :api_key
+
+    def initialize(api_key = '', api_client = ApiClient.default)
+      @api_key = api_key
+      @api_client = api_client
+    end
+    # /subaccounts/add
+    # Add a new subaccount
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20048]
+    def add(body = {}, opts = {})
+      data, _status_code, _headers = add_with_http_info(body, opts)
+      data
+    end
+
+    # /subaccounts/add
+    # Add a new subaccount
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20048, Fixnum, Hash)>] InlineResponse20048 data, response status code and response headers
+    def add_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/subaccounts/add'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20048')
+      return data, status_code, headers
+    end
+    # /subaccounts/delete
+    # Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20051]
+    def delete(body = {}, opts = {})
+      data, _status_code, _headers = delete_with_http_info(body, opts)
+      data
+    end
+
+    # /subaccounts/delete
+    # Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20051, Fixnum, Hash)>] InlineResponse20051 data, response status code and response headers
+    def delete_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/subaccounts/delete'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20051')
+      return data, status_code, headers
+    end
+    # /subaccounts/info
+    # Given the ID of an existing subaccount, return the data about it
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20049]
+    def info(body = {}, opts = {})
+      data, _status_code, _headers = info_with_http_info(body, opts)
+      data
+    end
+
+    # /subaccounts/info
+    # Given the ID of an existing subaccount, return the data about it
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20049, Fixnum, Hash)>] InlineResponse20049 data, response status code and response headers
+    def info_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/subaccounts/info'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20049')
+      return data, status_code, headers
+    end
+    # /subaccounts/list
+    # Get the list of subaccounts defined for the account, optionally filtered by a prefix
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<InlineResponse20047>]
+    def list(body = {}, opts = {})
+      data, _status_code, _headers = list_with_http_info(body, opts)
+      data
+    end
+
+    # /subaccounts/list
+    # Get the list of subaccounts defined for the account, optionally filtered by a prefix
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<InlineResponse20047>, Fixnum, Hash)>] Array<InlineResponse20047> data, response status code and response headers
+    def list_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/subaccounts/list'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'Array<InlineResponse20047>')
+      return data, status_code, headers
+    end
+    # /subaccounts/pause
+    # Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20052]
+    def pause(body = {}, opts = {})
+      data, _status_code, _headers = pause_with_http_info(body, opts)
+      data
+    end
+
+    # /subaccounts/pause
+    # Pause a subaccount&#39;s sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20052, Fixnum, Hash)>] InlineResponse20052 data, response status code and response headers
+    def pause_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/subaccounts/pause'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20052')
+      return data, status_code, headers
+    end
+    # /subaccounts/resume
+    # Resume a paused subaccount's sending
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20053]
+    def resume(body = {}, opts = {})
+      data, _status_code, _headers = resume_with_http_info(body, opts)
+      data
+    end
+
+    # /subaccounts/resume
+    # Resume a paused subaccount&#39;s sending
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20053, Fixnum, Hash)>] InlineResponse20053 data, response status code and response headers
+    def resume_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/subaccounts/resume'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20053')
+      return data, status_code, headers
+    end
+    # /subaccounts/update
+    # Update an existing subaccount
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse20050]
+    def update(body = {}, opts = {})
+      data, _status_code, _headers = update_with_http_info(body, opts)
+      data
+    end
+
+    # /subaccounts/update
+    # Update an existing subaccount
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse20050, Fixnum, Hash)>] InlineResponse20050 data, response status code and response headers
+    def update_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      local_var_path = '/subaccounts/update'
+
+      # http body (model)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :body => body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse20050')
+      return data, status_code, headers
+    end
+  end
+end