fuelsdk 0.0.1

data/samples/sample-AddSubscriberToList.rb

@@ -0,0 +1,52 @@
+require '../ET_Client.rb'
+
+begin
+	stubObj = ET_Client.new(false, false)
+
+	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
+
+	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])
+		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
+
+		# 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
+	end
+
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-CreateDataExtensions.rb

@@ -0,0 +1,51 @@
+require '../ET_Client.rb'
+
+begin
+	myclient = ET_Client.new(false, false)
+
+	## 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
+
+	# 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-bounceevent.rb

@@ -0,0 +1,68 @@
+require '../ET_Client.rb'
+
+begin
+	stubObj = ET_Client.new(false, false)
+
+	## 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 = ET_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.moreResults.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.moreResults do
+		p '>>> Continue Retrieve Filtered BounceEvents with GetMoreResults'
+		getResponse = getBounceEvent.getMoreResults
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'MoreResults: ' + getResponse.moreResults.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 = ET_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.moreResults.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.moreResults do
+		p '>>> Continue Retrieve All BounceEvents with GetMoreResults'
+		getResponse = getBounceEvent.getMoreResults
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'MoreResults: ' + getResponse.moreResults.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
+

data/samples/sample-campaign.rb

@@ -0,0 +1,212 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+require 'pry'
+
+
+begin
+	stubObj = FuelSDK::ET_Client.new auth
+
+	# Create List
+	p '>>> Create List'
+	postList = FuelSDK::ET_List.new
+	postList.authStub = stubObj
+	postList.props = {"ListName" => 'RubyAssetList', "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 for asset' unless postResponse.success?
+
+	# In order for this sample to run, it needs to have an asset that it can associate the campaign to
+	ExampleAssetType = "LIST"
+	ExampleAssetItemID = postResponse.results[0][:new_id]
+
+	# Retrieve all Campaigns
+	p '>>> Retrieve all Campaigns'
+	getCamp = FuelSDK::ET_Campaign.new
+	getCamp.authStub = stubObj
+	getResponse = getCamp.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 "Results: #{getResponse.results}"
+	p 'Results(Items) Length: ' + getResponse.results['items'].length.to_s
+	p '-----------------------------'
+
+  raise 'Failure retrieving campaigns' unless getResponse.success?
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve all Campaigns with GetMoreResults'
+		getResponse = getCamp.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 'Results(Items) Length: ' + getResponse.results['items'].length.to_s
+	end
+
+	# Create a new Campaign
+	p '>>> Create a new Campaign'
+	postCamp = FuelSDK::ET_Campaign.new
+	postCamp.authStub = stubObj
+	postCamp.props = {"name" => "RubySDKCreatedForTest1", "description"=> "RubySDKCreatedForTest", "color"=>"FF9933", "favorite"=>"false"}
+	postResponse = postCamp.post
+	p 'Post Status: ' + postResponse.status.to_s
+	p 'Code: ' + postResponse.code.to_s
+	p 'Message: ' + postResponse.message.to_s
+	p 'Results: ' + postResponse.results.to_json
+	p '-----------------------------'
+
+  raise 'Failure creating campaign' unless postResponse.success?
+
+	IDOfpostCampaign = postResponse.results['id']
+
+		# Retrieve the new Campaign
+		p '>>> Retrieve the new Campaign'
+		getCamp =  FuelSDK::ET_Campaign.new
+		getCamp.authStub = stubObj
+		getCamp.props = {"id" => IDOfpostCampaign}
+		getResponse = getCamp.get
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'Results: ' + getResponse.results.to_json
+		p '-----------------------------'
+
+  raise 'Failure retrieving campaign' unless getResponse.success?
+
+		# Update the new Campaign
+		p '>>> Update the new Campaign'
+		patchCamp = FuelSDK::ET_Campaign.new
+		patchCamp.authStub = stubObj
+		patchCamp.props = {"id"=> IDOfpostCampaign, "name" => "RubySDKCreated-Updated!"}
+		patchResponse = patchCamp.patch
+		p 'Patch Status: ' + patchResponse.status.to_s
+		p 'Code: ' + patchResponse.code.to_s
+		p 'Message: ' + patchResponse.message.to_s
+		p 'Results: ' + patchResponse.results.to_json
+		p '-----------------------------'
+
+  raise 'Failure updating campaign' unless patchResponse.success?
+
+		# Retrieve the updated Campaign
+		p '>>> Retrieve the updated Campaign'
+		getCamp = FuelSDK::ET_Campaign.new
+		getCamp.authStub = stubObj
+		getCamp.props = {"id" => IDOfpostCampaign}
+		getResponse = getCamp.get
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'Results: ' + getResponse.results.to_json
+		p '-----------------------------'
+
+  raise 'Failure retrieving campaign' unless getResponse.success?
+
+		# Create a new Campaign Asset
+		p '>>> Create a new Campaign Asset'
+		postCampAsset = FuelSDK::ET_Campaign::Asset.new
+		postCampAsset.authStub = stubObj
+		postCampAsset.props = {"id" => IDOfpostCampaign, "ids"=> [ExampleAssetItemID], "type"=> ExampleAssetType}
+		postResponse = postCampAsset.post
+		p 'Post Status: ' + postResponse.status.to_s
+		p 'Code: ' + postResponse.code.to_s
+		p 'Message: ' + postResponse.message.to_s
+		p 'Results: ' + postResponse.results.to_json
+		p '-----------------------------'
+
+  raise 'Failure creating campaign assets' unless postResponse.success?
+
+		IDOfpostCampaignAsset = postResponse.results[0]['id']
+
+		# Retrieve all Campaign Asset for a campaign
+		p '>>> Retrieve all Campaign Asset for a Campaign'
+		getCampAsset = FuelSDK::ET_Campaign::Asset.new
+		getCampAsset.authStub = stubObj
+		getCampAsset.props = {"id" => IDOfpostCampaign}
+		getResponse = getCampAsset.get
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'Results: ' + getResponse.results.inspect
+		p '-----------------------------'
+
+  raise 'Failure retrieving campaign assets' unless getResponse.success?
+
+		# Retrieve a single new Campaign Asset
+		p '>>> Retrieve a single new Campaign Asset'
+		getCampAsset = FuelSDK::ET_Campaign::Asset.new
+		getCampAsset.authStub = stubObj
+		getCampAsset.props = {"id" => IDOfpostCampaign, "assetId" => IDOfpostCampaignAsset}
+		getResponse = getCampAsset.get
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'Results: ' + getResponse.results.inspect
+		p '-----------------------------'
+
+  raise 'Failure retrieving campaign asset' unless getResponse.success?
+
+		# Delete the new Campaign Asset
+		p '>>> Delete the new Campaign Asset'
+		deleteCampAsset = FuelSDK::ET_Campaign::Asset.new
+		deleteCampAsset.authStub = stubObj
+		deleteCampAsset.props = {"id" => IDOfpostCampaign, "assetId"=> IDOfpostCampaignAsset}
+		deleteResponse = deleteCampAsset.delete
+		p 'Delete Status: ' + deleteResponse.status.to_s
+		p 'Code: ' + deleteResponse.code.to_s
+		p 'Message: ' + deleteResponse.message.to_s
+		p 'Results: ' + deleteResponse.results.to_json
+		p '-----------------------------'
+
+  raise 'Failure deleting campaign asset' unless deleteResponse.success?
+
+		# Get a single a new Campaign Asset to confirm deletion
+		p '>>> Get a single a new Campaign Asset to confirm deletion'
+		getCampAsset = FuelSDK::ET_Campaign::Asset.new
+		getCampAsset.authStub = stubObj
+		getCampAsset.props = {"id" => IDOfpostCampaign}
+		getResponse = getCampAsset.get
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'Results: ' + getResponse.results.inspect
+		p '-----------------------------'
+
+  raise 'Failure retrieving campaign asset' unless getResponse.success?
+  raise 'Failure retrieving campaign asset' unless getResponse.results['totalCount'] == 0
+
+rescue => e
+  p "Caught exception: #{e.message}"
+  p e.backtrace
+
+ensure
+		# Delete the new Campaign
+		p '>>> Delete the new Campaign'
+		deleteCamp = FuelSDK::ET_Campaign.new
+		deleteCamp.authStub = stubObj
+		deleteCamp.props = {"id"=> IDOfpostCampaign}
+		deleteResponse = deleteCamp.delete
+		p 'Delete Status: ' + deleteResponse.status.to_s
+		p 'Code: ' + deleteResponse.code.to_s
+		p 'Message: ' + deleteResponse.message.to_s
+		p 'Results: ' + deleteResponse.results.to_json
+		p '-----------------------------'
+
+  raise 'Failure deleting campaign asset' unless deleteResponse.success?
+
+		p '>>> Delete List'
+		deleteSub = FuelSDK::ET_List.new()
+		deleteSub.authStub = stubObj
+		deleteSub.props = {"ID" => ExampleAssetItemID}
+		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
+end

data/samples/sample-clickevent.rb

@@ -0,0 +1,68 @@
+require '../ET_Client.rb'
+
+begin
+	stubObj = ET_Client.new(false, false)
+
+	## 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 = '2013-01-15T13:00:00.000'
+
+	p '>>> Retrieve Filtered ClickEvents with GetMoreResults'
+	getClickEvent = ET_ClickEvent.new()
+	getClickEvent.authStub = stubObj
+	getClickEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
+	getClickEvent.filter = {'Property' => 'EventDate','SimpleOperator' => 'greaterThan','DateValue' => retrieveDate}
+	getResponse = getClickEvent.get
+	p 'Retrieve Status: ' + getResponse.status.to_s
+	p 'Code: ' + getResponse.code.to_s
+	p 'Message: ' + getResponse.message.to_s
+	p 'MoreResults: ' + getResponse.moreResults.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.moreResults do
+		p '>>> Continue Retrieve Filtered ClickEvents with GetMoreResults'
+		getResponse = getClickEvent.getMoreResults
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'MoreResults: ' + getResponse.moreResults.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 ClickEvents with GetMoreResults'
+	getClickEvent = ET_ClickEvent.new()
+	getClickEvent.authStub = stubObj
+	getClickEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
+	getResponse = getClickEvent.get
+	p 'Retrieve Status: ' + getResponse.status.to_s
+	p 'Code: ' + getResponse.code.to_s
+	p 'Message: ' + getResponse.message.to_s
+	p 'MoreResults: ' + getResponse.moreResults.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.moreResults do
+		p '>>> Continue Retrieve All ClickEvents with GetMoreResults'
+		getResponse = getClickEvent.getMoreResults
+		p 'Retrieve Status: ' + getResponse.status.to_s
+		p 'Code: ' + getResponse.code.to_s
+		p 'Message: ' + getResponse.message.to_s
+		p 'MoreResults: ' + getResponse.moreResults.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
+