MailchimpTransactional 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d3a432c47a5ca0bd269dfe8c9c783e256fdfa1db9752d30dd5ff1743256755a
+  data.tar.gz: cceba483082cc7edb39870625f75ba4bd5d14a8208d8323317d785c59bd42735
+SHA512:
+  metadata.gz: 316c3790329b72491b192a7eb772f1b55f7edc4d021310597a2900ddb6a7ba4f6eac2c969a62473eca81e03258b6a38f13d81a252fa663133685cc810f4a462a
+  data.tar.gz: 2c90408f2b8e846bce4a3f2f839fe5a53069e1c85d8f55f7552f156a65a9f8f3a0fcccb4207f81e24ef54b609237f5d0d663088d105af8a17012b40a0dcff20b

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/MailchimpTransactional.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "MailchimpTransactional/version"
+
+Gem::Specification.new do |s|
+  s.name        = "MailchimpTransactional"
+  s.version     = MailchimpTransactional::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Swagger-Codegen"]
+  s.email       = ["apihelp@mandrill.com"]
+  s.homepage    = "https://github.com/swagger-api/swagger-codegen"
+  s.summary     = "Mailchimp Transactional API Ruby Gem"
+  s.description = "Mailchimp Transactional Ruby SDK"
+  s.license     = 'Apache-2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/README.md

@@ -0,0 +1,174 @@
+# Mailchimp Transactional SDK — Ruby
+
+The official Ruby SDK for the Mailchimp Transactional API (v1)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build MailchimpTransactional.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./MailchimpTransactional-1.0.4.gem
+```
+(for development, run `gem install --dev ./MailchimpTransactional-1.0.4.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.4'
+
+### 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:
+
+    gem 'MailchimpTransactional', :git => 'https://github.com/postlight/mailchimp-transactional-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Quick Start
+
+```ruby
+require 'MailchimpTransactional'
+
+begin
+  client = MailchimpTransactional::Client.new(ENV['MANDRILL_KEY'])
+  result = client.users.ping() # => 'PONG!'
+  p result
+rescue MailchimpTransactional::ApiError => e
+  puts "Error: #{e}"
+end
+```
+
+## Sending Requests
+All requests are sent via POST and accept a single argument as the request body parameter.
+```ruby
+mailchimp.templates.publish({ :name => 'My Template' });
+```
+
+## Output Formats
+Optionally, you can set the default response format for **all requests** to one of the following:
+- `json` *(default)*
+- `xml`
+- `php`
+- `yaml`
+
+```ruby
+mailchimp.set_default_output_format('xml');
+```
+
+You can also set the response format for a **single request** by passing in a special `outputFormat` param to the request body.
+```ruby
+mailchimp.senders.list({ :outputFormat => 'php' });
+```
+
+## API Endpoints
+
+All URIs are relative to *https://mandrillapp.com/api/1.0*
+
+| SDK Method | Endpoint |
+| ---------- | -------- |
+| **exports.activity** | /exports/activity |
+| **exports.info** | /exports/info |
+| **exports.list** | /exports/list |
+| **exports.rejects** | /exports/rejects |
+| **exports.whitelist** | /exports/whitelist |
+| **inbound.add_domain** | /inbound/add-domain |
+| **inbound.add_route** | /inbound/add-route |
+| **inbound.check_domain** | /inbound/check-domain |
+| **inbound.delete_domain** | /inbound/delete-domain |
+| **inbound.delete_route** | /inbound/delete-route |
+| **inbound.domains** | /inbound/domains |
+| **inbound.routes** | /inbound/routes |
+| **inbound.send_raw** | /inbound/send-raw |
+| **inbound.update_route** | /inbound/update-route |
+| **ips.cancel_warmup** | /ips/cancel-warmup |
+| **ips.check_custom_dns** | /ips/check-custom-dns |
+| **ips.create_pool** | /ips/create-pool |
+| **ips.delete** | /ips/delete |
+| **ips.delete_pool** | /ips/delete-pool |
+| **ips.info** | /ips/info |
+| **ips.list** | /ips/list |
+| **ips.list_pools** | /ips/list-pools |
+| **ips.pool_info** | /ips/pool-info |
+| **ips.provision** | /ips/provision |
+| **ips.set_custom_dns** | /ips/set-custom-dns |
+| **ips.set_pool** | /ips/set-pool |
+| **ips.start_warmup** | /ips/start-warmup |
+| **messages.cancel_scheduled** | /messages/cancel-scheduled |
+| **messages.content** | /messages/content |
+| **messages.info** | /messages/info |
+| **messages.list_scheduled** | /messages/list-scheduled |
+| **messages.parse** | /messages/parse |
+| **messages.reschedule** | /messages/reschedule |
+| **messages.search** | /messages/search |
+| **messages.search_time_series** | /messages/search-time-series |
+| **messages.send** | /messages/send |
+| **messages.send_raw** | /messages/send-raw |
+| **messages.send_template** | /messages/send-template |
+| **metadata.add** | /metadata/add |
+| **metadata.delete** | /metadata/delete |
+| **metadata.list** | /metadata/list |
+| **metadata.update** | /metadata/update |
+| **rejects.add** | /rejects/add |
+| **rejects.delete** | /rejects/delete |
+| **rejects.list** | /rejects/list |
+| **senders.add_domain** | /senders/add-domain |
+| **senders.check_domain** | /senders/check-domain |
+| **senders.domains** | /senders/domains |
+| **senders.info** | /senders/info |
+| **senders.list** | /senders/list |
+| **senders.time_series** | /senders/time-series |
+| **senders.verify_domain** | /senders/verify-domain |
+| **subaccounts.add** | /subaccounts/add |
+| **subaccounts.delete** | /subaccounts/delete |
+| **subaccounts.info** | /subaccounts/info |
+| **subaccounts.list** | /subaccounts/list |
+| **subaccounts.pause** | /subaccounts/pause |
+| **subaccounts.resume** | /subaccounts/resume |
+| **subaccounts.update** | /subaccounts/update |
+| **tags.all_time_series** | /tags/all-time-series |
+| **tags.delete** | /tags/delete |
+| **tags.info** | /tags/info |
+| **tags.list** | /tags/list |
+| **tags.time_series** | /tags/time-series |
+| **templates.add** | /templates/add |
+| **templates.delete** | /templates/delete |
+| **templates.info** | /templates/info |
+| **templates.list** | /templates/list |
+| **templates.publish** | /templates/publish |
+| **templates.render** | /templates/render |
+| **templates.time_series** | /templates/time-series |
+| **templates.update** | /templates/update |
+| **urls.add_tracking_domain** | /urls/add-tracking-domain |
+| **urls.check_tracking_domain** | /urls/check-tracking-domain |
+| **urls.list** | /urls/list |
+| **urls.search** | /urls/search |
+| **urls.time_series** | /urls/time-series |
+| **urls.tracking_domains** | /urls/tracking-domains |
+| **users.info** | /users/info |
+| **users.ping** | /users/ping |
+| **users.ping2** | /users/ping2 |
+| **users.senders** | /users/senders |
+| **webhooks.add** | /webhooks/add |
+| **webhooks.delete** | /webhooks/delete |
+| **webhooks.info** | /webhooks/info |
+| **webhooks.list** | /webhooks/list |
+| **webhooks.update** | /webhooks/update |
+| **whitelists.add** | /whitelists/add |
+| **whitelists.delete** | /whitelists/delete |
+| **whitelists.list** | /whitelists/list |
+

data/lib/MailchimpTransactional.rb

@@ -0,0 +1,123 @@
+=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
+
+# Common files
+require 'MailchimpTransactional/api_client'
+require 'MailchimpTransactional/api_error'
+require 'MailchimpTransactional/version'
+
+
+# APIs
+require 'MailchimpTransactional/api/exports_api'
+require 'MailchimpTransactional/api/inbound_api'
+require 'MailchimpTransactional/api/ips_api'
+require 'MailchimpTransactional/api/messages_api'
+require 'MailchimpTransactional/api/metadata_api'
+require 'MailchimpTransactional/api/rejects_api'
+require 'MailchimpTransactional/api/senders_api'
+require 'MailchimpTransactional/api/subaccounts_api'
+require 'MailchimpTransactional/api/tags_api'
+require 'MailchimpTransactional/api/templates_api'
+require 'MailchimpTransactional/api/urls_api'
+require 'MailchimpTransactional/api/users_api'
+require 'MailchimpTransactional/api/webhooks_api'
+require 'MailchimpTransactional/api/whitelists_api'
+
+module MailchimpTransactional
+  class Client
+    def initialize(api_key = '')
+      @api_key = api_key
+      @api_client = ApiClient.new()
+
+      @Exports = ExportsApi.new(@api_key, @api_client)
+      @Inbound = InboundApi.new(@api_key, @api_client)
+      @Ips = IpsApi.new(@api_key, @api_client)
+      @Messages = MessagesApi.new(@api_key, @api_client)
+      @Metadata = MetadataApi.new(@api_key, @api_client)
+      @Rejects = RejectsApi.new(@api_key, @api_client)
+      @Senders = SendersApi.new(@api_key, @api_client)
+      @Subaccounts = SubaccountsApi.new(@api_key, @api_client)
+      @Tags = TagsApi.new(@api_key, @api_client)
+      @Templates = TemplatesApi.new(@api_key, @api_client)
+      @Urls = UrlsApi.new(@api_key, @api_client)
+      @Users = UsersApi.new(@api_key, @api_client)
+      @Webhooks = WebhooksApi.new(@api_key, @api_client)
+      @Whitelists = WhitelistsApi.new(@api_key, @api_client)
+    end
+
+    def set_api_key(api_key = '')
+      @api_key = api_key
+
+      @Exports = ExportsApi.new(@api_key, @api_client)
+      @Inbound = InboundApi.new(@api_key, @api_client)
+      @Ips = IpsApi.new(@api_key, @api_client)
+      @Messages = MessagesApi.new(@api_key, @api_client)
+      @Metadata = MetadataApi.new(@api_key, @api_client)
+      @Rejects = RejectsApi.new(@api_key, @api_client)
+      @Senders = SendersApi.new(@api_key, @api_client)
+      @Subaccounts = SubaccountsApi.new(@api_key, @api_client)
+      @Tags = TagsApi.new(@api_key, @api_client)
+      @Templates = TemplatesApi.new(@api_key, @api_client)
+      @Urls = UrlsApi.new(@api_key, @api_client)
+      @Users = UsersApi.new(@api_key, @api_client)
+      @Webhooks = WebhooksApi.new(@api_key, @api_client)
+      @Whitelists = WhitelistsApi.new(@api_key, @api_client)
+    end
+
+    def set_default_output_format(output_format)
+      @api_client.set_default_output_format(output_format)
+    end
+
+      def exports
+        @Exports
+      end
+      def inbound
+        @Inbound
+      end
+      def ips
+        @Ips
+      end
+      def messages
+        @Messages
+      end
+      def metadata
+        @Metadata
+      end
+      def rejects
+        @Rejects
+      end
+      def senders
+        @Senders
+      end
+      def subaccounts
+        @Subaccounts
+      end
+      def tags
+        @Tags
+      end
+      def templates
+        @Templates
+      end
+      def urls
+        @Urls
+      end
+      def users
+        @Users
+      end
+      def webhooks
+        @Webhooks
+      end
+      def whitelists
+        @Whitelists
+      end
+  end
+end

data/lib/MailchimpTransactional/api/exports_api.rb

@@ -0,0 +1,176 @@
+=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 ExportsApi
+    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
+    # /exports/activity
+    # 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
+    end
+
+    # /exports/activity
+    # 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 [Array<(InlineResponse2004, Fixnum, Hash)>] InlineResponse2004 data, response status code and response headers
+    def activity_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      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
+    end
+    # /exports/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
+    end
+
+    # /exports/info
+    # Returns information about an export job. If the export job&#39;s state is &#39;complete&#39;, 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 [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 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 = '/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
+    end
+    # /exports/list
+    # 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
+    end
+
+    # /exports/list
+    # Returns a list of your exports.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<InlineResponse2001>, Fixnum, Hash)>] Array<InlineResponse2001> 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 = '/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
+    end
+    # /exports/rejects
+    # 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
+    end
+
+    # /exports/rejects
+    # 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 [Array<(InlineResponse2002, Fixnum, Hash)>] InlineResponse2002 data, response status code and response headers
+    def rejects_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      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
+    end
+    # /exports/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
+    end
+
+    # /exports/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 [Array<(InlineResponse2003, Fixnum, Hash)>] InlineResponse2003 data, response status code and response headers
+    def whitelist_with_http_info(body, opts = {})
+      # add api key to request body
+      body[:key] = @api_key
+
+      # resource path
+      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
+    end
+  end
+end