marketingcloudsdk 1.0.0

data/marketingcloudsdk.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'marketingcloudsdk/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "marketingcloudsdk"
+	spec.version       = MarketingCloudSDK::VERSION
+	spec.authors       = ["Ashok Magar"]
+	spec.email         = ["amagar@salesforce.com"]
+	spec.description   = %q{API wrapper for SOAP and REST API with Salesforce Marketing Cloud (ExactTarget)}
+	spec.summary       = %q{Fuel Client Library for Ruby}
+	spec.homepage      = "https://github.com/ExactTarget/FuelSDK-Ruby"
+	spec.license       = ""
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(samples|test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler","~> 1.3"
+	spec.add_development_dependency 'rake','~>0.9'
+	spec.add_development_dependency "rspec",'~> 2.0'
+	spec.add_development_dependency "guard",'~> 1.1'
+	spec.add_development_dependency "guard-rspec",'~> 2.0'
+
+	spec.add_dependency "savon", "2.2.0"
+	spec.add_dependency "json", "~>1.8",">= 1.8.1" 
+	spec.add_dependency "jwt", "~>1.0",">= 1.0.0"
+end

data/samples/sample-AddSubscriberToList.rb

@@ -0,0 +1,56 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	stubObj = ET_Client.new auth
+
+	NewListName = "RubySDKList"
+
+	## Example using AddSubscriberToList() method
+	## Typically this method will be used with a pre-existing list but for testing purposes one is being created.
+
+	# Create List
+	p '>>> Create List'
+	postList = ET_List.new
+	postList.authStub = stubObj
+	postList.props = {"ListName" => NewListName, "Description" => "This list was created with the RubySDK", "Type" => "Private" }
+	postResponse = postList.post
+	p 'Post Status: ' + postResponse.status.to_s
+	p 'Code: ' + postResponse.code.to_s
+	p 'Message: ' + postResponse.message.to_s
+	p 'Result Count: ' + postResponse.results.length.to_s
+	p 'Results: ' + postResponse.results.inspect
+  raise 'Failure creating list' unless postResponse.success?
+
+	if postResponse.status then
+
+		newListID = postResponse.results[0][:new_id]
+		# Adding Subscriber To a List
+		p '>>> Add Subscriber To a List'
+		AddSubResponse = stubObj.AddSubscriberToList("AddSubTesting@bh.exacttarget.com", [newListID], "Test")
+		p 'AddSubResponse Status: ' + AddSubResponse.status.to_s
+		p 'Code: ' + AddSubResponse.code.to_s
+		p 'Message: ' + AddSubResponse.message.to_s
+		p 'Result Count: ' + AddSubResponse.results.length.to_s
+		p 'Results: ' + AddSubResponse.results.inspect
+    raise 'Failure adding user to list' unless AddSubResponse.success?
+
+		# Delete List
+		p '>>> Delete List'
+		deleteSub = ET_List.new()
+		deleteSub.authStub = stubObj
+		deleteSub.props = {"ID" => newListID}
+		deleteResponse = deleteSub.delete
+		p 'Delete Status: ' + deleteResponse.status.to_s
+		p 'Code: ' + deleteResponse.code.to_s
+		p 'Message: ' + deleteResponse.message.to_s
+		p 'Results Length: ' + deleteResponse.results.length.to_s
+		p 'Results: ' + deleteResponse.results.to_s
+    raise 'Failure deleting list' unless deleteResponse.success?
+	end
+
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-CreateAndStartDataExtensionImport.rb

@@ -0,0 +1,29 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	myclient = FuelSDK::Client.new auth
+	
+	DataExtensionCustomerKey = "62476204-bfd3-de11-95ca-001e0bbae8cc"
+	CSVFileName = "SDKExample.csv"
+	
+=begin
+	* Parameters:
+		* Data Extension CustomerKey - CustomerKey values are displayed in the UI as External Key   
+		* File Name - File must be a CSV located on your ExactTarget FTP Site
+		* Overwrite (Boolean) - Set to True in order to overwrite all existing data in the data extension. Required if Data Extension does not have a primary key.
+=end
+
+	response = myclient.CreateAndStartDataExtensionImport(DataExtensionCustomerKey, CSVFileName, true)
+	p 'Response Status: ' + response.status.to_s
+	p 'Code: ' + response.code.to_s
+	p 'Message: ' + response.message.to_s	
+	p 'Results Length: ' + response.results.length.to_s
+	p 'Results: ' + response.results.to_s
+	
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+
+

data/samples/sample-CreateAndStartListImport.rb

@@ -0,0 +1,27 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	myclient = FuelSDK::Client.new auth
+	ListID = "1956035"
+	CSVFileName = "SDKExample.csv"
+	
+=begin
+	* Parameters:
+		* List ID  
+		* File Name - File must be a CSV located on your ExactTarget FTP Site
+=end
+	
+	response = myclient.CreateAndStartListImport(ListID, CSVFileName)
+	p 'Response Status: ' + response.status.to_s
+	p 'Code: ' + response.code.to_s
+	p 'Message: ' + response.message.to_s	
+	p 'Results Length: ' + response.results.length.to_s
+	p 'Results: ' + response.results.to_s
+	
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+
+

data/samples/sample-CreateContentAreas.rb

@@ -0,0 +1,48 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	myclient = FuelSDK::Client.new auth
+	
+	## Example using CreateContentAreas() method
+	
+	NameOfContentAreaOne = "ExampleContentAreaOne"
+	NameOfContentAreaTwo = "ExampleContentAreaTwo"
+
+	# Declare a Ruby Hash which contain all of the details for a DataExtension
+	contAreaOne = {"CustomerKey" => NameOfContentAreaOne, "Name"=>NameOfContentAreaOne, "Content"=> "<b>Some HTML Content Goes here</b>"}
+	contAreaTwo = {"CustomerKey" => NameOfContentAreaTwo, "Name"=>NameOfContentAreaTwo, "Content"=> "<b>Some Different HTML Content Goes here</b>"}
+	
+	# Call CreateDataExtensions passing in both DataExtension Hashes as an Array
+	response = myclient.CreateContentAreas([contAreaOne,contAreaTwo])
+	p 'Response Status: ' + response.status.to_s
+	p 'Code: ' + response.code.to_s
+	p 'Message: ' + response.message.to_s	
+	p 'Results Length: ' + response.results.length.to_s
+	p 'Results: ' + response.results.to_s
+
+	p '>>> Delete contAreaOne'
+	contArea = ET_ContentArea.new 
+	contArea.authStub = myclient
+	contArea.props = {"CustomerKey" => NameOfContentAreaOne}
+	delResponse = contArea.delete
+	p 'Delete Status: ' + delResponse.status.to_s
+	p 'Code: ' + delResponse.code.to_s
+	p 'Message: ' + delResponse.message.to_s
+	p 'Results: ' + delResponse.results.inspect
+	
+	p '>>> Delete contAreaTwo'
+	contArea = ET_ContentArea.new 
+	contArea.authStub = myclient
+	contArea.props = {"CustomerKey" => NameOfContentAreaTwo}
+	delResponse = contArea.delete
+	p 'Delete Status: ' + delResponse.status.to_s
+	p 'Code: ' + delResponse.code.to_s
+	p 'Message: ' + delResponse.message.to_s
+	p 'Results: ' + delResponse.results.inspect
+	
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-CreateDataExtensions.rb

@@ -0,0 +1,54 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	myclient = ET_Client.new auth
+
+	## Example using CreateDataExtensions() method
+
+	# Declare a Ruby Hash which contain all of the details for a DataExtension
+	deOne = {"Name" => "HelperDEOne","CustomerKey" => "HelperDEOne"}
+	deOne['columns'] = [{"Name" => "Name", "FieldType" => "Text", "IsPrimaryKey" => "true", "MaxLength" => "100", "IsRequired" => "true"},{"Name" => "OtherField", "FieldType" => "Text"}]
+
+	# Declare a 2nd Ruby Hash which contain all of the details for a DataExtension
+	deTwo = {"Name" => "HelperDETwo","CustomerKey" => "HelperDETwo"}
+	deTwo['columns'] = [{"Name" => "Name", "FieldType" => "Text", "IsPrimaryKey" => "true", "MaxLength" => "100", "IsRequired" => "true"},{"Name" => "OtherField", "FieldType" => "Text"}]
+
+	# Call CreateDataExtensions passing in both DataExtension Hashes as an Array
+	createDEResponse = myclient.CreateDataExtensions([deOne, deTwo])
+	p 'CreateDataExtensions Status: ' + createDEResponse.status.to_s
+	p 'Code: ' + createDEResponse.code.to_s
+	p 'Message: ' + createDEResponse.message.to_s
+	p 'Results Length: ' + createDEResponse.results.length.to_s
+	p 'Results: ' + createDEResponse.results.to_s
+  raise 'Failure creating data extensions' unless createDEResponse.success?
+  raise 'Failure creating data extensions' unless createDEResponse.results.count == 2
+
+	# Cleaning up the newly created DEs
+	# Delete deOne
+	p '>>> Delete deOne'
+	de5 = ET_DataExtension.new
+	de5.authStub = myclient
+	de5.props = {"CustomerKey" => "HelperDEOne"}
+	delResponse = de5.delete
+	p 'Delete Status: ' + delResponse.status.to_s
+	p 'Code: ' + delResponse.code.to_s
+	p 'Message: ' + delResponse.message.to_s
+	p 'Results: ' + delResponse.results.inspect
+
+	# Delete deTwo
+	p '>>> Delete deTwo'
+	de5 = ET_DataExtension.new
+	de5.authStub = myclient
+	de5.props = {"CustomerKey" => "HelperDETwo"}
+	delResponse = de5.delete
+	p 'Delete Status: ' + delResponse.status.to_s
+	p 'Code: ' + delResponse.code.to_s
+	p 'Message: ' + delResponse.message.to_s
+	p 'Results: ' + delResponse.results.inspect
+
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-CreateProfileAttributes.rb

@@ -0,0 +1,48 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	myclient = FuelSDK::Client.new auth
+	
+	## Example using CreateProfileAttributes() method
+	
+	NameOfAttributeOne = "ExampleAttributeOne"
+	NameOfAttributeTwo = "ExampleAttributeTwo"
+
+	# Declare a Ruby Hash which contain all of the details for a DataExtension
+	profileAttrOne = {"Name" => NameOfAttributeOne, "PropertyType"=>"string", "Description"=>"New Attribute from the SDK", "IsRequired"=>"false", "IsViewable"=>"false", "IsEditable"=>"true", "IsSendTime"=>"false"}
+	profileAttrTwo = {"Name" => NameOfAttributeTwo, "PropertyType"=>"string", "Description"=>"New Attribute from the SDK", "IsRequired"=>"false", "IsViewable"=>"false", "IsEditable"=>"true", "IsSendTime"=>"false"}
+	
+	# Call CreateDataExtensions passing in both DataExtension Hashes as an Array
+	response = myclient.CreateProfileAttributes([profileAttrOne,profileAttrTwo])
+	p 'Response Status: ' + response.status.to_s
+	p 'Code: ' + response.code.to_s
+	p 'Message: ' + response.message.to_s	
+	p 'Results Length: ' + response.results.length.to_s
+	p 'Results: ' + response.results.to_s
+	
+	p '>>> Delete profileAttrOne'
+	profileattr = ET_ProfileAttribute.new 
+	profileattr.authStub = myclient
+	profileattr.props = {"Name" => NameOfAttributeOne}
+	delResponse = profileattr.delete
+	p 'Delete Status: ' + delResponse.status.to_s
+	p 'Code: ' + delResponse.code.to_s
+	p 'Message: ' + delResponse.message.to_s
+	p 'Results: ' + delResponse.results.inspect
+	
+	p '>>> Delete profileAttrTwo'
+	profileattr = ET_ProfileAttribute.new 
+	profileattr.authStub = myclient
+	profileattr.props = {"Name" => NameOfAttributeTwo}
+	delResponse = profileattr.delete
+	p 'Delete Status: ' + delResponse.status.to_s
+	p 'Code: ' + delResponse.code.to_s
+	p 'Message: ' + delResponse.message.to_s
+	p 'Results: ' + delResponse.results.inspect
+	
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-SendEmailToDataExtension.rb

@@ -0,0 +1,23 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	myclient = FuelSDK::Client.new auth
+	
+	EmailIDForSendDefinition = "3113962"
+	SendClassificationCustomerKey = "2239"
+	SendableDataExtensionCustomerKey = "F6F3871A-D124-499B-BBF5-3EFC0E827A51"
+
+	# Call SendEmailToDataExtension
+	response = myclient.SendEmailToDataExtension(EmailIDForSendDefinition, SendableDataExtensionCustomerKey,SendClassificationCustomerKey)
+	p 'Response Status: ' + response.status.to_s
+	p 'Code: ' + response.code.to_s
+	p 'Message: ' + response.message.to_s	
+	p 'Results Length: ' + response.results.length.to_s
+	p 'Results: ' + response.results.to_s
+
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-SendEmailToList.rb

@@ -0,0 +1,23 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	myclient = FuelSDK::Client.new auth
+	
+	EmailIDForSendDefinition = "3113962"
+	ListIDForSendDefinition = "1729515"
+	SendClassificationCustomerKey = "2239"
+	
+	# Call SendEmailToList
+	response = myclient.SendEmailToList(EmailIDForSendDefinition, ListIDForSendDefinition,SendClassificationCustomerKey)
+	p 'Response Status: ' + response.status.to_s
+	p 'Code: ' + response.code.to_s
+	p 'Message: ' + response.message.to_s	
+	p 'Results Length: ' + response.results.length.to_s
+	p 'Results: ' + response.results.to_s
+	
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-SendTriggeredSends.rb

@@ -0,0 +1,30 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	myclient = FuelSDK::Client.new auth
+	
+	TriggeredSendCustomerKey = "TEXTEXT"
+	AltTriggeredSendCustomerKey = "FailTest"
+	SubscriberEmailAddress = "SDKExample@bh.exacttarget.com"
+	
+	# Call SendTriggeredSends which can be used to send emails to multiple definitions with a single request
+	# Limit usage to 50 subscribers per request. 
+	tsOne = {"CustomerKey" => TriggeredSendCustomerKey}
+	tsOne['Subscribers'] = [{"EmailAddress"=>SubscriberEmailAddress, "SubscriberKey" => SubscriberEmailAddress}]
+	tsTwo = {"CustomerKey" => AltTriggeredSendCustomerKey}
+	tsTwo['Subscribers'] = [{"EmailAddress"=>SubscriberEmailAddress, "SubscriberKey" => SubscriberEmailAddress}]
+	
+	response = myclient.SendTriggeredSends([tsOne,tsTwo])
+	p 'Response Status: ' + response.status.to_s
+	p 'Code: ' + response.code.to_s
+	p 'Message: ' + response.message.to_s	
+	p 'Results Length: ' + response.results.length.to_s
+	p 'Results: ' + response.results.to_s
+	
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+
+

data/samples/sample-bounceevent.rb

@@ -0,0 +1,70 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	stubObj = FuelSDK::Client.new auth
+
+	## Modify the date below to reduce the number of results returned from the request
+	## Setting this too far in the past could result in a very large response size
+	retrieveDate = '2011-01-15T13:00:00.000'
+
+	p '>>> Retrieve Filtered BounceEvents with GetMoreResults'
+	getBounceEvent = FuelSDK::BounceEvent.new()
+	getBounceEvent.authStub = stubObj
+	getBounceEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
+	getBounceEvent.filter = {'Property' => 'EventDate','SimpleOperator' => 'greaterThan','DateValue' => retrieveDate}
+	getResponse = getBounceEvent.get
+	p 'Retrieve Status: ' + getResponse.status.to_s
+	p 'Code: ' + getResponse.code.to_s
+	p 'Message: ' + getResponse.message.to_s
+	p 'MoreResults: ' + getResponse.more?.to_s
+	p 'RequestID: ' + getResponse.request_id.to_s
+	p 'Results Length: ' + getResponse.results.length.to_s
+	# Since this could potentially return a large number of results, we do not want to print the results
+	p 'Results: ' + getResponse.results.to_s
+  raise 'Failure retrieving bounce events' unless getResponse.success?
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve Filtered BounceEvents with GetMoreResults'
+		getResponse = getBounceEvent.continue
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'MoreResults: ' + getResponse.more?.to_s
+		p 'RequestID: ' + getResponse.request_id.to_s
+		p 'Results Length: ' + getResponse.results.length.to_s
+	end
+
+	#  The following request could potentially bring back large amounts of data if run against a production account
+=begin
+	p '>>> Retrieve All BounceEvents with GetMoreResults'
+	getBounceEvent = FuelSDK::BounceEvent.new()
+	getBounceEvent.authStub = stubObj
+	getBounceEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
+	getResponse = getBounceEvent.get
+	p 'Retrieve Status: ' + getResponse.status.to_s
+	p 'Code: ' + getResponse.code.to_s
+	p 'Message: ' + getResponse.message.to_s
+	p 'MoreResults: ' + getResponse.more?.to_s
+	p 'RequestID: ' + getResponse.request_id.to_s
+	p 'Results Length: ' + getResponse.results.length.to_s
+	# Since this could potentially return a large number of results, we do not want to print the results
+	#p 'Results: ' + getResponse.results.to_s
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve All BounceEvents with GetMoreResults'
+		getResponse = getBounceEvent.continue
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'MoreResults: ' + getResponse.more?.to_s
+		p 'RequestID: ' + getResponse.request_id.to_s
+		p 'Results Length: ' + getResponse.results.length.to_s
+	end
+=end
+
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+