sfmc-fuelsdk-ruby 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3079faef2d297a9fb708fc9bb3bcc71f9bce3db371359a96ec621bb716e281c
-  data.tar.gz: 957550337f783b15637f431fa0f3b07567c2f85ca2473213b06ca917f55f2ee6
+  metadata.gz: 3a05834436829d49ca8336cd49946a56bed5f003f709a512a1ecb9637cec3031
+  data.tar.gz: 8f00eed0dd3e176c72042cf404b0fb7e06b71820f69df8417581c51a90e68869
 SHA512:
-  metadata.gz: c4ff5b9020c3d6b41b8caa7f69e49202fbb079b77d62a77226ce8bf96bf5f2a62f80347c2f2d4a1d7f549bf6de86bb52d0b65e2b67d434781dd8bb4f27704c45
-  data.tar.gz: 4948aa1cb5041c2c4b80760a981ddede7d446af2208a50a2d5297d70c030207c49d374327f81c905a47742bd6f12dcee7f6f6f31453640acd34d88d18e962f7f
+  metadata.gz: a8ee8667e093661ebed4f9433f3de2010079117db931f917ddda8cefb5eef8e511a8857bd457731cb0cb217d46212a0f0b9b71cb41010ea6f3670aafadc50267
+  data.tar.gz: db4f4acc5d67666bef2a109460fdc018be30f438751968cb235d64663f73b5ec34cb1d8acc18cbd8574760ac3c5205dfe3105a819cade0030527609f51c38007

data/.gitignore

@@ -1,28 +1,28 @@
-*.gem
-*.rbc
-.bundle
-.config
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-samples/soap_cache_file.json
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
-sample.rb
-ExactTargetWSDL.xml
-config.yaml
-/objsamples/config.yaml
-/objsamples/AllTest.bat
-samples/sample_helper.rb
-.DS_STORE
-gengem.bat
-.idea
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+samples/soap_cache_file.json
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+sample.rb
+ExactTargetWSDL.xml
+config.yaml
+/objsamples/config.yaml
+/objsamples/AllTest.bat
+samples/sample_helper.rb
+.DS_STORE
+gengem.bat
+.idea

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
-
-gemspec
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -1,90 +1,92 @@
-PATH
-  remote: .
-  specs:
-    sfmc-fuelsdk-ruby (1.1.0)
-      json (~> 1.8, >= 1.8.1)
-      jwt (~> 1.0, >= 1.0.0)
-      savon (= 2.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    akami (1.2.2)
-      gyoku (>= 0.4.0)
-      nokogiri
-    builder (3.2.3)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    ffi (1.9.25)
-    ffi (1.9.25-x86-mingw32)
-    formatador (0.2.5)
-    guard (1.8.3)
-      formatador (>= 0.2.4)
-      listen (~> 1.3)
-      lumberjack (>= 1.0.2)
-      pry (>= 0.9.10)
-      thor (>= 0.14.6)
-    guard-rspec (2.6.0)
-      guard (>= 1.8)
-      rspec (~> 2.13)
-    gyoku (1.0.0)
-      builder (>= 2.1.2)
-    httpi (2.0.2)
-      rack
-    json (1.8.6)
-    jwt (1.5.6)
-    listen (1.3.1)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-      rb-kqueue (>= 0.2)
-    lumberjack (1.0.13)
-    method_source (0.9.0)
-    mini_portile2 (2.3.0)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
-    nori (2.1.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.0.6)
-    rake (0.9.6)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rb-kqueue (0.2.5)
-      ffi (>= 0.5.0)
-    rspec (2.99.0)
-      rspec-core (~> 2.99.0)
-      rspec-expectations (~> 2.99.0)
-      rspec-mocks (~> 2.99.0)
-    rspec-core (2.99.2)
-    rspec-expectations (2.99.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.99.4)
-    savon (2.2.0)
-      akami (~> 1.2.0)
-      builder (>= 2.1.2)
-      gyoku (~> 1.0.0)
-      httpi (~> 2.0.2)
-      nokogiri (>= 1.4.0)
-      nori (~> 2.1.0)
-      wasabi (~> 3.1.0)
-    thor (0.20.0)
-    wasabi (3.1.0)
-      httpi (~> 2.0)
-      nokogiri (>= 1.4.0)
-
-PLATFORMS
-  ruby
-  x86-mingw32
-
-DEPENDENCIES
-  bundler (~> 1.3)
-  guard (~> 1.1)
-  guard-rspec (~> 2.0)
-  rake (~> 0.9)
-  rspec (~> 2.0)
-  sfmc-fuelsdk-ruby!
-
-BUNDLED WITH
-   1.17.1
+PATH
+  remote: .
+  specs:
+    sfmc-fuelsdk-ruby (1.2.0)
+      json (~> 1.8, >= 1.8.1)
+      jwt (~> 1.0, >= 1.0.0)
+      savon (= 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    akami (1.2.2)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.2.3)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    ffi (1.9.25-x64-mingw32)
+    ffi (1.9.25-x86-mingw32)
+    formatador (0.2.5)
+    guard (1.8.3)
+      formatador (>= 0.2.4)
+      listen (~> 1.3)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.6.0)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    gyoku (1.0.0)
+      builder (>= 2.1.2)
+    httpi (2.0.2)
+      rack
+    json (1.8.6)
+    jwt (1.5.6)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.1-x64-mingw32)
+      mini_portile2 (~> 2.4.0)
+    nori (2.1.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.6)
+    rake (0.9.6)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rb-kqueue (0.2.5)
+      ffi (>= 0.5.0)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+    savon (2.2.0)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 1.0.0)
+      httpi (~> 2.0.2)
+      nokogiri (>= 1.4.0)
+      nori (~> 2.1.0)
+      wasabi (~> 3.1.0)
+    thor (0.20.0)
+    wasabi (3.1.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+  x86-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  guard (~> 1.1)
+  guard-rspec (~> 2.0)
+  rake (~> 0.9)
+  rspec (~> 2.0)
+  sfmc-fuelsdk-ruby!
+
+BUNDLED WITH
+   1.17.1

data/Guardfile

@@ -1,8 +1,8 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-guard 'rspec' do
-  watch('spec/spec_helper.rb')  { "spec" }
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-end
-
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+guard 'rspec' do
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+end
+

data/LICENSE.md

@@ -1,13 +1,13 @@
-Copyright (c) 2013 ExactTarget, Inc.
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Copyright (c) 2013 ExactTarget, Inc.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,143 +1,166 @@
-FuelSDK-Ruby / MarketingCloudSDK-Ruby
-=====================================
-
-ExactTarget Fuel SDK / SalesforceMarektingCloudSDK for Ruby
-
-## Overview ##
-The Fuel SDK for Ruby provides easy access to ExactTarget's Fuel API Family services, including a collection of REST APIs and a SOAP API. These APIs provide access to ExactTarget functionality via common collection types such as array/hash.
-
-## New Features in Version 1.1.0 ##
-- **Added support for your tenant's endpoints - [More Details](https://developer.salesforce.com/docs/atlas.en-us.mc-apis.meta/mc-apis/your-subdomain-tenant-specific-endpoints.htm) **
-- **MarketingCloudSDK gem will be available as sfmc-fuelsdk-ruby on ruby gems.
-
-## Migrationg to version to version 1.0 ##
-- **FuelSDK gem has been renamed to MarketingCloudSDK and will be availbale as marketingcloudsdk on ruby gems.
-  
-## New Features in Version .9 ##
-- **Streamlined Folder Support**: All objects that support folders within the UI now have a standardized property called folderId.
-- **Interaction Support**: Now supports Import and Email::SendDefinition objects .
-- **Profile Attribute Support**: Added the ability to manage profile attributes through the ProfileAttribute object.
-- **Support for single request to Add/Update**:A single request can be made which will create the object if one doesn't already or update one if it does.  This works for Subscriber, DataExtension::Row, and List objects using the Put method.
-- **Tracking Events Batching Support**: By default, all tracking event types will only pull new data since the last time a request was made using the same filter.  If you would like to override this functionality to pull all data, simply set the GetSinceLastBatch property to false.
-- **Automatic Asset Organization for Hub Apps**: Applications that authenticate by providing a JWT will automatically have all created assets placed into a folder based on the HubExchange app's name. 
-- **Greater Flexibility for Authentication**:Yaml config file is no longer required in order to define the authentication parameters.  They are now required inputs when instantiating the Client class so they can be stored anywhere.
- 
-## Migrating from old version ##
-- MarkeitngCloudSDK is now gem, Going forward FuelSDK gem will be available as marketingcloudsdk on ruby gems.
-- Config.yaml is no longer used.  ClientID/ClientSecret will now need to be passed when instantiating the Client class.
-- Previous versions of the SalesforceMarketingCloudSDK  exposed objects with the prefix "ET_". For backwards compatibility you can still access objects this way.
-Subscriber can be accessed using MarketingCloudSDK::Subscriber or ET_Subscriber.  
-
-## Requirements ##
-- Ruby Version 2.2.5
-- Savon 2.2.0 
-
-## Getting Started ##
-Build the gem from the source
-
-```ruby
-gem build marketingcloudsdk.gemspec
-```
-
-Install the newly built gem
-
-```ruby
-gem install marketingcloudsdk-1.1.0.gem
-```
-
-If you have not registered your application or you need to lookup your Application Key or Application Signature values, please go to App Center at [Code@: ExactTarget's Developer Community](http://code.exacttarget.com/appcenter "Code@ App Center").
-
-
-## Example Request ##
-
-Add a require statement to reference the SalesforceMarketingCloud SDK's functionality:
-> require 'marketingcloudsdk'
-
-Next, create an instance of the Client class:
-> myClient = MarketingCloudSDK::Client.new {'client' => { 'id' => CLIENTID, 'secret' => SECRET }}
-
-Create an instance of the object type we want to work with:
-> list = MarketingCloudSDK::List.new
-
-Associate the Client to the object using the client property:
-> list.client = myClient
-
-Utilize one of the List methods:
-> response = list.get
-
-Print out the results for viewing
-> p response
-
-**Example Output:**
-
-<pre>
-<MarketingCloudSDK::SoapResponse:0x007fb86abcf190
- @body= {:retrieve_response_msg=> {:overall_status=>"OK", :request_id=>"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", :results=>..}
- @code= 200,
- @message= 'OK',
- @request_id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
- @results=
-  [{:client=>{:id=>"xxxx"},
-    :partner_key=>nil,
-    :created_date=>
-     #<DateTime: 2013-05-30T23:02:00+00:00 ((2456443j,82920s,0n),+0s,2299161j)>,
-    :id=>"xxxx",
-    :object_id=>nil,
-    :email_address=>"xxxx",
-    :attributes=>
-     [{:name=>"Full Name", :value=>"Justin Barber"},
-      {:name=>"Gender", :value=>nil},
-      {:name=>"Email Address", :value=>"xxx"},
-      {:name=>"User Defined", :value=>"02/02/1982"}],
-    :subscriber_key=>"xxxx",
-    :status=>"Active",
-    :email_type_preference=>"HTML",
-    :"@xsi:type"=>"Subscriber"},
- @success=true>
-</pre>
-
-## Client Class ##
-
-The Client class takes care of many of the required steps when accessing ExactTarget's API, including retrieving appropriate access tokens, handling token state for managing refresh, and determining the appropriate endpoints for API requests.  In order to leverage the advantages this class provides, use a single instance of this class for an entire session.  Do not instantiate a new Client object for each request made.
-
-Client class accepts multiple parameters
-
-**Parameters** - Allows for passing authentication information for use with SSO with a JWT or for passing ClientID/ClientSecret. 
-Additionally the API hostname (base_api_url),Authentication URL (request_token_url) and the SOAP endpoint (soap_endpoint) is now configurable:
-
-Example passing ClientID/ClientSecret: 
-> myclient = MarketingCloudSDK::Client.new({'client' => {'id' => 'exampleID','secret' => 'exampleSecret'}})
-
-Example passing ClientID/ClientSecret/AppSignature/JWT: 
-> myclient = MarketingCloudSDK::Client.new({'client' => {'id' => 'exampleID','secret' => 'exampleSecret', 'signature'=>'examplesig'}, 'jwt'=>'exampleJWT'})
-
-Example passing ClientID/ClientSecret/BaseAPIUrl/ReqTokenAuthUrl/Soap Endpoint
-> myclient = MarketingCloudSDK::Client.new('client' => {'id' => 'exampleID', 'secret' => 'exampleSecret', 'base_api_url' => 'http://getapis', 'request_token_url' => 'http://authapi', 'soap_endpoint' => 'http://soapendpoint'})
-
-**Note** - The following defaults apply if the following parameters are omitted:
-- base_api_url: https://www.exacttargetapis.com
-- request_token_url: https://auth.exacttargetapis.com/v1/requestToken
-- soap_endpoint: https://webservice.exacttarget.com/Service.asmx
-
-**Debug** - If 2nd parameter for debug is set to true, all API requests that the Fuel SDK is making behind the scenes will be logged.  This option should only be set to true in order to troubleshoot during the development process and should never be used in a production scenario.
-> myclient = MarketingCloudSDK::Client.new auth, true <br> 
-
-
-## Responses ##
-All methods on MarketingCloud SDK objects return a generic object that follows the same structure, regardless of the type of call.  This object contains a common set of properties used to display details about the request.
-
-- success?: Boolean value that indicates if the call was successful
-- code: HTTP Error Code (will always be 200 for SOAP requests)
-- message: Text values containing more details in the event of an error
-- results: Collection containing the details unique to the method called.
- - more? - Boolean value that indicates on Get requests if more data is available.
-
-
-## Samples ##
-Find more sample files that illustrate using all of the available functions for ExactTarget objects exposed through the API in the samples directory.
-
-
-
-
-
-
+FuelSDK-Ruby / MarketingCloudSDK-Ruby
+=====================================
+
+ExactTarget Fuel SDK / SalesforceMarektingCloudSDK for Ruby
+
+## Overview ##
+The Fuel SDK for Ruby provides easy access to ExactTarget's Fuel API Family services, including a collection of REST APIs and a SOAP API. These APIs provide access to ExactTarget functionality via common collection types such as array/hash.
+
+
+## New Features in Version 1.2.0 ##
+- **OAuth2 authentication support** - [More Details](https://developer.salesforce.com/docs/atlas.en-us.mc-app-development.meta/mc-app-development/integration-considerations.htm)
+
+    To enable OAuth2 authentication, pass ```use_oAuth2_authentication => true``` in the params argument to the Client's class constructor.
+    
+    Example of instantiating the Client class:
+    
+    ```
+    myclient = MarketingCloudSDK::Client.new({
+        'client' => {
+            'id' => '<CLIENT_ID>',
+            'secret' => '<CLIENT_SECRET>',
+            'request_token_url' => '<AUTH TENANT SPECIFIC ENDPOINT>',
+            'soap_endpoint' => '<SOAP TENANT SPECIFIC ENDPOINT>',
+            'base_api_url' => '<REST TENANT SPECIFIC ENDPOINT>',
+            'use_oAuth2_authentication' => true,
+            'account_id' => <TARGET_ACCOUNT_ID>,
+            'scope' => '<PERMISSION_LIST>'
+            }
+        })
+    ```
+
+## New Features in Version 1.1.0 ##
+- **Added support for your tenant's endpoints - [More Details](https://developer.salesforce.com/docs/atlas.en-us.mc-apis.meta/mc-apis/your-subdomain-tenant-specific-endpoints.htm) **
+- **MarketingCloudSDK gem will be available as sfmc-fuelsdk-ruby on ruby gems.
+
+## Migrationg to version to version 1.0 ##
+- **FuelSDK gem has been renamed to MarketingCloudSDK and will be availbale as marketingcloudsdk on ruby gems.
+  
+## New Features in Version .9 ##
+- **Streamlined Folder Support**: All objects that support folders within the UI now have a standardized property called folderId.
+- **Interaction Support**: Now supports Import and Email::SendDefinition objects .
+- **Profile Attribute Support**: Added the ability to manage profile attributes through the ProfileAttribute object.
+- **Support for single request to Add/Update**:A single request can be made which will create the object if one doesn't already or update one if it does.  This works for Subscriber, DataExtension::Row, and List objects using the Put method.
+- **Tracking Events Batching Support**: By default, all tracking event types will only pull new data since the last time a request was made using the same filter.  If you would like to override this functionality to pull all data, simply set the GetSinceLastBatch property to false.
+- **Automatic Asset Organization for Hub Apps**: Applications that authenticate by providing a JWT will automatically have all created assets placed into a folder based on the HubExchange app's name. 
+- **Greater Flexibility for Authentication**:Yaml config file is no longer required in order to define the authentication parameters.  They are now required inputs when instantiating the Client class so they can be stored anywhere.
+ 
+## Migrating from old version ##
+- MarkeitngCloudSDK is now gem, Going forward FuelSDK gem will be available as marketingcloudsdk on ruby gems.
+- Config.yaml is no longer used.  ClientID/ClientSecret will now need to be passed when instantiating the Client class.
+- Previous versions of the SalesforceMarketingCloudSDK  exposed objects with the prefix "ET_". For backwards compatibility you can still access objects this way.
+Subscriber can be accessed using MarketingCloudSDK::Subscriber or ET_Subscriber.  
+
+## Requirements ##
+- Ruby Version 2.2.5
+- Savon 2.2.0 
+
+## Getting Started ##
+Build the gem from the source
+
+```ruby
+gem build marketingcloudsdk.gemspec
+```
+
+Install the newly built gem
+
+```ruby
+gem install marketingcloudsdk-1.2.0.gem
+```
+
+If you have not registered your application or you need to lookup your Application Key or Application Signature values, please go to App Center at [Code@: ExactTarget's Developer Community](http://code.exacttarget.com/appcenter "Code@ App Center").
+
+
+## Example Request ##
+
+Add a require statement to reference the SalesforceMarketingCloud SDK's functionality:
+> require 'marketingcloudsdk'
+
+Next, create an instance of the Client class:
+> myClient = MarketingCloudSDK::Client.new {'client' => { 'id' => CLIENTID, 'secret' => SECRET }}
+
+Create an instance of the object type we want to work with:
+> list = MarketingCloudSDK::List.new
+
+Associate the Client to the object using the client property:
+> list.client = myClient
+
+Utilize one of the List methods:
+> response = list.get
+
+Print out the results for viewing
+> p response
+
+**Example Output:**
+
+<pre>
+<MarketingCloudSDK::SoapResponse:0x007fb86abcf190
+ @body= {:retrieve_response_msg=> {:overall_status=>"OK", :request_id=>"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", :results=>..}
+ @code= 200,
+ @message= 'OK',
+ @request_id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+ @results=
+  [{:client=>{:id=>"xxxx"},
+    :partner_key=>nil,
+    :created_date=>
+     #<DateTime: 2013-05-30T23:02:00+00:00 ((2456443j,82920s,0n),+0s,2299161j)>,
+    :id=>"xxxx",
+    :object_id=>nil,
+    :email_address=>"xxxx",
+    :attributes=>
+     [{:name=>"Full Name", :value=>"Justin Barber"},
+      {:name=>"Gender", :value=>nil},
+      {:name=>"Email Address", :value=>"xxx"},
+      {:name=>"User Defined", :value=>"02/02/1982"}],
+    :subscriber_key=>"xxxx",
+    :status=>"Active",
+    :email_type_preference=>"HTML",
+    :"@xsi:type"=>"Subscriber"},
+ @success=true>
+</pre>
+
+## Client Class ##
+
+The Client class takes care of many of the required steps when accessing ExactTarget's API, including retrieving appropriate access tokens, handling token state for managing refresh, and determining the appropriate endpoints for API requests.  In order to leverage the advantages this class provides, use a single instance of this class for an entire session.  Do not instantiate a new Client object for each request made.
+
+Client class accepts multiple parameters
+
+**Parameters** - Allows for passing authentication information for use with SSO with a JWT or for passing ClientID/ClientSecret. 
+Additionally the API hostname (base_api_url),Authentication URL (request_token_url) and the SOAP endpoint (soap_endpoint) is now configurable:
+
+Example passing ClientID/ClientSecret: 
+> myclient = MarketingCloudSDK::Client.new({'client' => {'id' => 'exampleID','secret' => 'exampleSecret'}})
+
+Example passing ClientID/ClientSecret/AppSignature/JWT: 
+> myclient = MarketingCloudSDK::Client.new({'client' => {'id' => 'exampleID','secret' => 'exampleSecret', 'signature'=>'examplesig'}, 'jwt'=>'exampleJWT'})
+
+Example passing ClientID/ClientSecret/BaseAPIUrl/ReqTokenAuthUrl/Soap Endpoint
+> myclient = MarketingCloudSDK::Client.new('client' => {'id' => 'exampleID', 'secret' => 'exampleSecret', 'base_api_url' => 'http://getapis', 'request_token_url' => 'http://authapi', 'soap_endpoint' => 'http://soapendpoint'})
+
+**Note** - The following defaults apply if the following parameters are omitted:
+- base_api_url: https://www.exacttargetapis.com
+- request_token_url: https://auth.exacttargetapis.com/v1/requestToken
+- soap_endpoint: https://webservice.exacttarget.com/Service.asmx
+
+**Debug** - If 2nd parameter for debug is set to true, all API requests that the Fuel SDK is making behind the scenes will be logged.  This option should only be set to true in order to troubleshoot during the development process and should never be used in a production scenario.
+> myclient = MarketingCloudSDK::Client.new auth, true <br> 
+
+
+## Responses ##
+All methods on MarketingCloud SDK objects return a generic object that follows the same structure, regardless of the type of call.  This object contains a common set of properties used to display details about the request.
+
+- success?: Boolean value that indicates if the call was successful
+- code: HTTP Error Code (will always be 200 for SOAP requests)
+- message: Text values containing more details in the event of an error
+- results: Collection containing the details unique to the method called.
+ - more? - Boolean value that indicates on Get requests if more data is available.
+
+
+## Samples ##
+Find more sample files that illustrate using all of the available functions for ExactTarget objects exposed through the API in the samples directory.
+
+
+
+
+
+