MailchimpTransactional 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b7f006ff801831790e455857e889daad7ea3239d32721e200e59b0b05b658d
-  data.tar.gz: 1977467035f0a8dd0035619f2ce5b8cc3293764eed8359963b58c15da9c9a4fe
+  metadata.gz: ea5ba09deeffc4acce96a3b4c1195538f9a5318041f30193991306c95f769ef1
+  data.tar.gz: 1ddf40db693a44983e566c585f8779916065aa96303c4ed3aafeff93355af856
 SHA512:
-  metadata.gz: 1a232a09ac396bd9ab660f1718d94caa0a34277ba1c0d270524bb132779e24ef580058bb57a182021e96400f0fe8e419ecbbb410d1a5ff5592ee4904d16093e4
-  data.tar.gz: 100b14706cd3ab9f7843fe7c3b946bd04f34b657ae02ff2d95410c95bd53bfb92738bdb887d9e350b94d3070bb9b3d07a355912a4d74c4c149ab175a4be7e153
+  metadata.gz: b0e94fab3ac65187e1609dbf4cd8fb5a0f36395afcf0b33424a235182782ff48f63278eb6a5d5358ede31fdb67562d8a9de4df4b38bfd0455ccc4be732391442
+  data.tar.gz: e0c81af8a5167abaebf80b963d50990b278f538a0dcfd6409407a7026d817f1ec24af7fbe5663b2aa1846303e6372a4d815d4a6663539c9560d843b54afbe6d1

data/MailchimpTransactional.gemspec

@@ -5,7 +5,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 1.0.6
+OpenAPI spec version: 1.0.8
 Contact: apihelp@mandrill.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12

data/README.md

@@ -1,6 +1,6 @@
-# Mailchimp Transactional SDK — Ruby
+# Mailchimp Transactional — Ruby
 
-The official Ruby SDK for the Mailchimp Transactional API (v1)
+The official Ruby client library for the Mailchimp Transactional API (v1)
 
 ## Installation
 
@@ -15,21 +15,21 @@ gem build MailchimpTransactional.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./MailchimpTransactional-1.0.6.gem
+gem install ./MailchimpTransactional-1.0.8.gem
 ```
-(for development, run `gem install --dev ./MailchimpTransactional-1.0.6.gem` to install the development dependencies)
+(for development, run `gem install --dev ./MailchimpTransactional-1.0.8.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'MailchimpTransactional', '~> 1.0.6'
+    gem 'MailchimpTransactional', '~> 1.0.8'
 
 ### Install from Git
 
-If the Ruby gem is hosted at a git repository: https://github.com/postlight/mailchimp-transactional-ruby, then add the following in the Gemfile:
+If the Ruby gem is hosted at a git repository: https://github.com/mailchimp/mailchimp-transactional-ruby, then add the following in the Gemfile:
 
-    gem 'MailchimpTransactional', :git => 'https://github.com/postlight/mailchimp-transactional-ruby.git'
+    gem 'MailchimpTransactional', :git => 'https://github.com/mailchimp/mailchimp-transactional-ruby.git'
 
 ### Include the Ruby code directly
 
@@ -79,7 +79,7 @@ mailchimp.senders.list({ :outputFormat => 'php' });
 
 All URIs are relative to *https://mandrillapp.com/api/1.0*
 
-| SDK Method | Endpoint |
+| Method | Endpoint |
 | ---------- | -------- |
 | **exports.activity** | /exports/activity |
 | **exports.info** | /exports/info |
@@ -172,3 +172,22 @@ All URIs are relative to *https://mandrillapp.com/api/1.0*
 | **whitelists.delete** | /whitelists/delete |
 | **whitelists.list** | /whitelists/list |
 
+
+## Additional Client Libraries
+
+Mailchimp Transactional libraries are available in the following languages:
+
+<div>
+  <a href="https://github.com/mailchimp/mailchimp-transactional-node">
+  <img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/master/resources/images/lang_node.png?raw=true" width="44" height="44">
+  </a>
+  <a href="https://github.com/mailchimp/mailchimp-transactional-php">
+  <img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/master/resources/images/lang_php.png?raw=true" width="44" height="44">
+  </a>
+  <a href="https://github.com/mailchimp/mailchimp-transactional-ruby">
+  <img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/master/resources/images/lang_ruby.png?raw=true" width="44" height="44">
+  </a>
+  <a href="https://github.com/mailchimp/mailchimp-transactional-python">
+  <img src="https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/master/resources/images/lang_python.png?raw=true" width="44" height="44">
+  </a>
+</div>

data/lib/MailchimpTransactional.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 1.0.6
+OpenAPI spec version: 1.0.8
 Contact: apihelp@mandrill.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12

data/lib/MailchimpTransactional/api/exports_api.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 1.0.6
+OpenAPI spec version: 1.0.8
 Contact: apihelp@mandrill.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12
@@ -22,17 +22,17 @@ module MailchimpTransactional
       @api_key = api_key
       @api_client = api_client
     end
-    # /exports/activity
+    # Export activity history
     # Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse2004]
     def activity(body = {}, opts = {})
-      data, _status_code, _headers = activity_with_http_info(body, opts)
+      data = activity_with_http_info(body, opts)
       data
     end
 
-    # /exports/activity
+    # Export activity history
     # Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.
     # @param body 
     # @param [Hash] opts the optional parameters
@@ -45,24 +45,20 @@ module MailchimpTransactional
       local_var_path = '/exports/activity'
 
       # 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 => 'InlineResponse2004')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /exports/info
+    # View export info
     # Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse200]
     def info(body = {}, opts = {})
-      data, _status_code, _headers = info_with_http_info(body, opts)
+      data = info_with_http_info(body, opts)
       data
     end
 
-    # /exports/info
+    # View export info
     # Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.
     # @param body 
     # @param [Hash] opts the optional parameters
@@ -75,24 +71,20 @@ module MailchimpTransactional
       local_var_path = '/exports/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 => 'InlineResponse200')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /exports/list
+    # List exports
     # Returns a list of your exports.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<InlineResponse2001>]
     def list(body = {}, opts = {})
-      data, _status_code, _headers = list_with_http_info(body, opts)
+      data = list_with_http_info(body, opts)
       data
     end
 
-    # /exports/list
+    # List exports
     # Returns a list of your exports.
     # @param body 
     # @param [Hash] opts the optional parameters
@@ -105,24 +97,20 @@ module MailchimpTransactional
       local_var_path = '/exports/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<InlineResponse2001>')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /exports/rejects
+    # Export blacklist
     # Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse2002]
     def rejects(body = {}, opts = {})
-      data, _status_code, _headers = rejects_with_http_info(body, opts)
+      data = rejects_with_http_info(body, opts)
       data
     end
 
-    # /exports/rejects
+    # Export blacklist
     # Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.
     # @param body 
     # @param [Hash] opts the optional parameters
@@ -135,24 +123,20 @@ module MailchimpTransactional
       local_var_path = '/exports/rejects'
 
       # 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 => 'InlineResponse2002')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /exports/whitelist
+    # Export whitelist
     # Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse2003]
     def whitelist(body = {}, opts = {})
-      data, _status_code, _headers = whitelist_with_http_info(body, opts)
+      data = whitelist_with_http_info(body, opts)
       data
     end
 
-    # /exports/whitelist
+    # Export whitelist
     # Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.
     # @param body 
     # @param [Hash] opts the optional parameters
@@ -165,12 +149,8 @@ module MailchimpTransactional
       local_var_path = '/exports/whitelist'
 
       # 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 => 'InlineResponse2003')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
   end
 end

data/lib/MailchimpTransactional/api/inbound_api.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 1.0.6
+OpenAPI spec version: 1.0.8
 Contact: apihelp@mandrill.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12
@@ -22,18 +22,18 @@ module MailchimpTransactional
       @api_key = api_key
       @api_client = api_client
     end
-    # /inbound/add-domain
-    # Add a new template
+    # Add inbound domain
+    # Add an inbound domain to your account.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse2006]
     def add_domain(body = {}, opts = {})
-      data, _status_code, _headers = add_domain_with_http_info(body, opts)
+      data = add_domain_with_http_info(body, opts)
       data
     end
 
-    # /inbound/add-domain
-    # Add a new template
+    # Add inbound domain
+    # Add an inbound domain to your account.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(InlineResponse2006, Fixnum, Hash)>] InlineResponse2006 data, response status code and response headers
@@ -45,25 +45,21 @@ module MailchimpTransactional
       local_var_path = '/inbound/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 => 'InlineResponse2006')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /inbound/add-route
-    # Add a new mailbox route to an inbound domain
+    # Add mailbox route
+    # Add a new mailbox route to an inbound domain.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse20010]
     def add_route(body = {}, opts = {})
-      data, _status_code, _headers = add_route_with_http_info(body, opts)
+      data = add_route_with_http_info(body, opts)
       data
     end
 
-    # /inbound/add-route
-    # Add a new mailbox route to an inbound domain
+    # Add mailbox route
+    # Add a new mailbox route to an inbound domain.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(InlineResponse20010, Fixnum, Hash)>] InlineResponse20010 data, response status code and response headers
@@ -75,25 +71,21 @@ module MailchimpTransactional
       local_var_path = '/inbound/add-route'
 
       # 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 => 'InlineResponse20010')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /inbound/check-domain
-    # Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call
+    # Check domain settings
+    # Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse2007]
     def check_domain(body = {}, opts = {})
-      data, _status_code, _headers = check_domain_with_http_info(body, opts)
+      data = check_domain_with_http_info(body, opts)
       data
     end
 
-    # /inbound/check-domain
-    # Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call
+    # Check domain settings
+    # Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(InlineResponse2007, Fixnum, Hash)>] InlineResponse2007 data, response status code and response headers
@@ -105,24 +97,20 @@ module MailchimpTransactional
       local_var_path = '/inbound/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 => 'InlineResponse2007')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /inbound/delete-domain
+    # Delete inbound domain
     # Delete an inbound domain from the account. All mail will stop routing for this domain immediately.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse2008]
     def delete_domain(body = {}, opts = {})
-      data, _status_code, _headers = delete_domain_with_http_info(body, opts)
+      data = delete_domain_with_http_info(body, opts)
       data
     end
 
-    # /inbound/delete-domain
+    # Delete inbound domain
     # Delete an inbound domain from the account. All mail will stop routing for this domain immediately.
     # @param body 
     # @param [Hash] opts the optional parameters
@@ -135,25 +123,21 @@ module MailchimpTransactional
       local_var_path = '/inbound/delete-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 => 'InlineResponse2008')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /inbound/delete-route
-    # Delete an existing inbound mailbox route
+    # Delete mailbox route
+    # Delete an existing inbound mailbox route.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse20012]
     def delete_route(body = {}, opts = {})
-      data, _status_code, _headers = delete_route_with_http_info(body, opts)
+      data = delete_route_with_http_info(body, opts)
       data
     end
 
-    # /inbound/delete-route
-    # Delete an existing inbound mailbox route
+    # Delete mailbox route
+    # Delete an existing inbound mailbox route.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(InlineResponse20012, Fixnum, Hash)>] InlineResponse20012 data, response status code and response headers
@@ -165,25 +149,21 @@ module MailchimpTransactional
       local_var_path = '/inbound/delete-route'
 
       # 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 => 'InlineResponse20012')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /inbound/domains
-    # Add an inbound domain to your account
+    # List inbound domains
+    # List the domains that have been configured for inbound delivery.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<InlineResponse2005>]
     def domains(body = {}, opts = {})
-      data, _status_code, _headers = domains_with_http_info(body, opts)
+      data = domains_with_http_info(body, opts)
       data
     end
 
-    # /inbound/domains
-    # Add an inbound domain to your account
+    # List inbound domains
+    # List the domains that have been configured for inbound delivery.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<InlineResponse2005>, Fixnum, Hash)>] Array<InlineResponse2005> data, response status code and response headers
@@ -195,25 +175,21 @@ module MailchimpTransactional
       local_var_path = '/inbound/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<InlineResponse2005>')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /inbound/routes
-    # List the mailbox routes defined for an inbound domain
+    # List mailbox routes
+    # List the mailbox routes defined for an inbound domain.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<InlineResponse2009>]
     def routes(body = {}, opts = {})
-      data, _status_code, _headers = routes_with_http_info(body, opts)
+      data = routes_with_http_info(body, opts)
       data
     end
 
-    # /inbound/routes
-    # List the mailbox routes defined for an inbound domain
+    # List mailbox routes
+    # List the mailbox routes defined for an inbound domain.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<InlineResponse2009>, Fixnum, Hash)>] Array<InlineResponse2009> data, response status code and response headers
@@ -225,25 +201,21 @@ module MailchimpTransactional
       local_var_path = '/inbound/routes'
 
       # 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<InlineResponse2009>')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /inbound/send-raw
-    # Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP
+    # Send mime document
+    # Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<InlineResponse20013>]
     def send_raw(body = {}, opts = {})
-      data, _status_code, _headers = send_raw_with_http_info(body, opts)
+      data = send_raw_with_http_info(body, opts)
       data
     end
 
-    # /inbound/send-raw
-    # Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP
+    # Send mime document
+    # Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<InlineResponse20013>, Fixnum, Hash)>] Array<InlineResponse20013> data, response status code and response headers
@@ -255,24 +227,20 @@ module MailchimpTransactional
       local_var_path = '/inbound/send-raw'
 
       # 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<InlineResponse20013>')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
-    # /inbound/update-route
+    # Update mailbox route
     # Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [InlineResponse20011]
     def update_route(body = {}, opts = {})
-      data, _status_code, _headers = update_route_with_http_info(body, opts)
+      data = update_route_with_http_info(body, opts)
       data
     end
 
-    # /inbound/update-route
+    # Update mailbox route
     # Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.
     # @param body 
     # @param [Hash] opts the optional parameters
@@ -285,12 +253,8 @@ module MailchimpTransactional
       local_var_path = '/inbound/update-route'
 
       # 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 => 'InlineResponse20011')
-      return data, status_code, headers
+      data = @api_client.call_api(:POST, local_var_path, :body => body)
+      return data
     end
   end
 end