MailchimpMarketing 3.0.2 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4386b4522fc6e07c725cf36df587059791ef8f2001ec0866792d8781552ab817
-  data.tar.gz: 20bd69131ba866959d87b3771cc3a89db1ffa422c9bb8ba896e6b1e5caa0cbdb
+  metadata.gz: 1fa0c5a22cb183467a5e02936e9e4a31ce2cc64f0c0c06d1003d63f5253065b7
+  data.tar.gz: 0301af633c2dc7daafb5820c27d69ee0286fdef88c02c8a907862cbb096da2a9
 SHA512:
-  metadata.gz: becf448023ac1849b55ced81716ddbeeb7b0dc9c7dbe70f4796dd1e74a9599c8425b526e5623b386b822de4b27140e9dc05cb2c3c9a57403ff5633df75018208
-  data.tar.gz: d8256f767a149577aac0f450a375a2b03225e67a6e34c31b1b8035c39d0de55f59ab5fc005566e7e2486c9baea8005afe148994ea8782344071fef91649f2130
+  metadata.gz: 9a9507c87aa9bd57c593fbd3b5abfd23898a1b96154667b38cce1e71b18e50652828a0c93adea39010969e14bcfdd5f8685442190465103e1e70728c08688a89
+  data.tar.gz: 82ae5ceef2516d0a2047c2d9744d17d3f7406989ffdbc42db8af69fe02b3029551e5681054f5b91f64923e06de640ee401ac152a9f8a5141d7863de770a3fe7c

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 12.3.3'
 end

data/MailchimpMarketing.gemspec

@@ -5,7 +5,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 3.0.2
+OpenAPI spec version: 3.0.9
 Contact: apihelp@mailchimp.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12
@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   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 'excon', '~> 0.76.0'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'

data/README.md

@@ -1,42 +1,27 @@
-# Mailchimp Marketing SDK — Ruby
+# Mailchimp Marketing — Ruby
 
-The official Ruby SDK for the Mailchimp Marketing API (v1)
+The official Ruby client library for the Mailchimp Marketing API (v1)
 
 ## Installation
 
-### Build a gem
-
-To build the Ruby code into a gem:
+### via RubyGems
 
 ```shell
-gem build MailchimpMarketing.gemspec
+gem install MailchimpMarketing
 ```
 
-Then either install the gem locally:
+### via Git
 
 ```shell
-gem install ./MailchimpMarketing-3.0.2.gem
+gem 'MailchimpMarketing', :git => 'https://github.com/mailchimp/mailchimp-marketing-ruby.git'
 ```
-(for development, run `gem install --dev ./MailchimpMarketing-3.0.2.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 'MailchimpMarketing', '~> 3.0.2'
-
-### Install from Git
 
-If the Ruby gem is hosted at a git repository: https://github.com/postlight/mailchimp-marketing-ruby, then add the following in the Gemfile:
-
-    gem 'MailchimpMarketing', :git => 'https://github.com/postlight/mailchimp-marketing-ruby.git'
-
-### Include the Ruby code directly
-
-Include the Ruby code directly using `-I` as follows:
+### via Local Installation
 
 ```shell
-ruby -Ilib script.rb
+gem build MailchimpMarketing.gemspec
+gem install ./MailchimpMarketing-3.0.9.gem
+gem 'MailchimpMarketing', '~> 3.0.9'
 ```
 
 ## Quick Start
@@ -46,7 +31,10 @@ require 'MailchimpMarketing'
 
 begin
   client = MailchimpMarketing::Client.new()
-  client.set_config(ENV['API_KEY'], ENV['API_SERVER'])
+  client.set_config({
+    :api_key => 'YOUR_API_KEY',
+    :server => 'YOUR_SERVER_PREFIX'
+  })
   result = client.ping.get()
   p result
 rescue MailchimpMarketing::ApiError => e
@@ -54,17 +42,44 @@ rescue MailchimpMarketing::ApiError => e
 end
 ```
 
-If your api key contains a server suffix (i.e. '-us19'), passing in the server key may be omitted, like so:
+## Authentication Methods
+
+The client library can be configured to use either **Basic Auth** or **OAuth2**. A server prefix should be provided i.e. `us19`, in order for the client to determine to appropriate host url.
+
+### Basic Auth
+
+```ruby
+client.set_config({
+  :api_key => 'YOUR_API_KEY',
+  :server => 'YOUR_SERVER_PREFIX'
+})
+```
+
+### OAuth2
+
+```ruby
+client.set_config({
+  :access_token => 'YOUR_ACCESS_TOKEN',
+  :server => 'YOUR_SERVER_PREFIX'
+})
+```
+
+### Shorthand
+
+As a shortcut, the configuration object can be passed in directly when creating the client.
 
-```python
-client.setConfig(ENV['API_KEY'])
+```ruby
+client = MailchimpMarketing::Client.new({
+  :api_key => 'YOUR_API_KEY',
+  :server => 'YOUR_SERVER_PREFIX'
+})
 ```
 
 ## API Endpoints
 
 All URIs are relative to *https://server.api.mailchimp.com/3.0*
 
-| SDK Method | Endpoint |
+| Method | Endpoint |
 | ---------- | -------- |
 | **activityFeed.get** | /activity-feed |
 | **activityFeed.get_chimp_chatter** | /activity-feed/chimp-chatter |
@@ -342,28 +357,22 @@ All URIs are relative to *https://server.api.mailchimp.com/3.0*
 | **verifiedDomains.submit_domain_verification** | /verified-domains/{domain_name}/actions/verify |
 
 
-## Additional SDKs
+## Additional Client Libraries
 
-Mailchimp Marketing SDKs are available in a number of additional languages.
+Mailchimp Marketing libraries are available in the following languages:
 
 <div>
-  <a href="https://github.com/postlight/mailchimp-marketing-node">
-  <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_node.png?raw=true" width="44" height="44">
-  </a>
-  <a href="https://github.com/postlight/mailchimp-marketing-php">
-  <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_php.png?raw=true" width="44" height="44">
-  </a>
-  <a href="https://github.com/postlight/mailchimp-marketing-ruby">
-  <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_ruby.png?raw=true" width="44" height="44">
+  <a href="https://github.com/mailchimp/mailchimp-marketing-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/postlight/mailchimp-marketing-python">
-  <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_python.png?raw=true" width="44" height="44">
+  <a href="https://github.com/mailchimp/mailchimp-marketing-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/postlight/mailchimp-marketing-java">
-  <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_java.png?raw=true" width="44" height="44">
+  <a href="https://github.com/mailchimp/mailchimp-marketing-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/postlight/mailchimp-marketing-csharp">
-  <img src="https://github.com/postlight/mailchimp/blob/master/resources/images/lang_csharp.png?raw=true" width="44" height="44">
+  <a href="https://github.com/mailchimp/mailchimp-marketing-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/MailchimpMarketing.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 3.0.2
+OpenAPI spec version: 3.0.9
 Contact: apihelp@mailchimp.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12
@@ -15,7 +15,6 @@ require 'MailchimpMarketing/api_client'
 require 'MailchimpMarketing/api_error'
 require 'MailchimpMarketing/version'
 
-
 # APIs
 require 'MailchimpMarketing/api/activity_feed_api'
 require 'MailchimpMarketing/api/authorized_apps_api'
@@ -46,8 +45,8 @@ require 'MailchimpMarketing/api/verified_domains_api'
 
 module MailchimpMarketing
   class Client
-    def initialize(api_key = '', server = '')
-      @api_client = ApiClient.new(api_key, server)
+    def initialize(config = {})
+      @api_client = ApiClient.new(config)
 
       @ActivityFeed = ActivityFeedApi.new(@api_client)
       @AuthorizedApps = AuthorizedAppsApi.new(@api_client)
@@ -77,8 +76,8 @@ module MailchimpMarketing
       @VerifiedDomains = VerifiedDomainsApi.new(@api_client)
     end
 
-    def set_config(api_key = '', server = '')
-      @api_client.set_config(api_key, server)
+    def set_config(config = {})
+      @api_client.set_config(config)
     end
 
       def activityFeed

data/lib/MailchimpMarketing/api/activity_feed_api.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 3.0.2
+OpenAPI spec version: 3.0.9
 Contact: apihelp@mailchimp.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12
@@ -19,94 +19,33 @@ module MailchimpMarketing
     def initialize(api_client)
       @api_client = api_client
     end
-    # Get information about the activity feed endpoint's resources
-    # Get information about the activity feed endpoint's resources.
-    # @param [Hash] opts the optional parameters
-    # @return [ActivityFeedRoot]
-    def get(opts = {})
-      data, _status_code, _headers = get_with_http_info(opts)
-      data
-    end
 
-    # Get information about the activity feed endpoint's resources
-    # Get information about the activity feed endpoint's resources.
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(ActivityFeedRoot, Fixnum, Hash)>] ActivityFeedRoot data, response status code and response headers
-    def get_with_http_info(opts = {})
-      # resource path
-      local_var_path = '/activity-feed'
+    # List activity feed resources
+    def get(opts = {})
 
-      # 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']
+
+      local_var_path = '/activity-feed'
       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 => 'ActivityFeedRoot')
+        :body => post_body)
       return data, status_code, headers
     end
-    # Chimp Chatter activity
-    # Return the Chimp Chatter for this account ordered by most recent
-    # @param [Hash] opts the optional parameters
-    # @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 [InlineResponse200]
-    def get_chimp_chatter(opts = {})
-      data, _status_code, _headers = get_chimp_chatter_with_http_info(opts)
-      data
-    end
 
-    # Chimp Chatter activity
-    # Return the Chimp Chatter for this account ordered by most recent
-    # @param [Hash] opts the optional parameters
-    # @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<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers
-    def get_chimp_chatter_with_http_info(opts = {})
-      # resource path
-      local_var_path = '/activity-feed/chimp-chatter'
+    # Get latest chimp chatter
+    def get_chimp_chatter(opts = {})
+      fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
 
-      # query parameters
       query_params = {}
       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']
+
+      local_var_path = '/activity-feed/chimp-chatter'
       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 => 'InlineResponse200')
+        :body => post_body)
       return data, status_code, headers
     end
   end

data/lib/MailchimpMarketing/api/authorized_apps_api.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-OpenAPI spec version: 3.0.2
+OpenAPI spec version: 3.0.9
 Contact: apihelp@mailchimp.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.12
@@ -19,152 +19,52 @@ module MailchimpMarketing
     def initialize(api_client)
       @api_client = api_client
     end
-    # Get a list of authorized apps
-    # Get a list of an account's registered, connected applications.
-    # @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 [InlineResponse2001]
-    def list(opts = {})
-      data, _status_code, _headers = list_with_http_info(opts)
-      data
-    end
 
-    # Get a list of authorized apps
-    # Get a list of an account&#39;s registered, connected applications.
-    # @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<(InlineResponse2001, Fixnum, Hash)>] InlineResponse2001 data, response status code and response headers
-    def list_with_http_info(opts = {})
-      # resource path
-      local_var_path = '/authorized-apps'
+    # List authorized apps
+    def list(opts = {})
+      fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
 
-      # 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']
+
+      local_var_path = '/authorized-apps'
       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 => 'InlineResponse2001')
+        :body => post_body)
       return data, status_code, headers
     end
-    # Get information about a specific authorized app
-    # Get information about a specific authorized application.
-    # @param app_id The unique id for the connected authorized application.
-    # @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 [InlineResponse2001Apps]
-    def get(app_id = {}, opts = {})
-      data, _status_code, _headers = get_with_http_info(app_id, opts)
-      data
-    end
 
-    # Get information about a specific authorized app
-    # Get information about a specific authorized application.
-    # @param app_id The unique id for the connected authorized application.
-    # @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<(InlineResponse2001Apps, Fixnum, Hash)>] InlineResponse2001Apps data, response status code and response headers
-    def get_with_http_info(app_id, opts = {})
-      # resource path
-      local_var_path = '/authorized-apps/{app_id}'.sub('{' + 'app_id' + '}', app_id.to_s)
+    # Get authorized app info
+    def get(app_id, opts = {})
+      fail ArgumentError, "Missing required param: 'app_id'" if app_id.nil?
 
-      # 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']
+
+      local_var_path = '/authorized-apps/{app_id}'.sub('{' + 'app_id' + '}', app_id.to_s)
       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 => 'InlineResponse2001Apps')
+        :body => post_body)
       return data, status_code, headers
     end
-    # Link your application
-    # Retrieve OAuth2-based credentials to associate API calls with your application.
-    # @param client_details Use this endpoint to link your application and retrieve OAuth2-based credentials. This is useful if you can&#39;t implement the OAuth2 flow but still want to associate calls with your application.
-    # @param [Hash] opts the optional parameters
-    # @return [InlineResponse2002]
-    def link(client_details = {}, opts = {})
-      data, _status_code, _headers = link_with_http_info(client_details, opts)
-      data
-    end
 
-    # Link your application
-    # Retrieve OAuth2-based credentials to associate API calls with your application.
-    # @param client_details Use this endpoint to link your application and retrieve OAuth2-based credentials. This is useful if you can&#39;t implement the OAuth2 flow but still want to associate calls with your application.
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse2002, Fixnum, Hash)>] InlineResponse2002 data, response status code and response headers
-    def link_with_http_info(client_details, opts = {})
-      # resource path
-      local_var_path = '/authorized-apps'
+    # Link application
+    def link(client_details, opts = {})
+      fail ArgumentError, "Missing required param: 'client_details'" if client_details.nil?
 
-      # 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(client_details)
-      auth_names = ['basicAuth']
+
+      local_var_path = '/authorized-apps'
       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 => 'InlineResponse2002')
+        :body => post_body)
       return data, status_code, headers
     end
   end