fuelsdk 0.0.1

data/samples/sample-list.rb

@@ -0,0 +1,105 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	stubObj = FuelSDK::ET_Client.new auth
+
+	NewListName = "RubySDKList"
+
+	# Create List
+	p '>>> Create List'
+	postList = FuelSDK::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?
+
+
+	# Make sure the list created correctly before
+	if postResponse.success? then
+
+		newListID = postResponse.results[0][:new_id]
+
+		# Retrieve newly created List by ID
+		p '>>> Retrieve newly created List'
+		getList = FuelSDK::ET_List.new()
+		getList.authStub = stubObj
+		getList.props = ["ID","PartnerKey","CreatedDate","ModifiedDate","Client.ID","Client.PartnerClientKey","ListName","Description","Category","Type","CustomerKey","ListClassification","AutomatedEmail.ID"]
+		getList.filter = {'Property' =>  'ID','SimpleOperator' => 'equals','Value' => newListID}
+		getResponse = getList.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 Length: ' + getResponse.results.length.to_s
+		p 'Results: ' + getResponse.results.to_s
+    raise 'Failure retrieving list' unless getResponse.success?
+
+		# Update List
+		p '>>> Update List'
+		patchSub = FuelSDK::ET_List.new
+		patchSub.authStub = stubObj
+		patchSub.props = {"ID" => newListID, "Description" => "I updated the description"}
+		patchResponse = patchSub.patch
+		p 'Patch Status: ' + patchResponse.status.to_s
+		p 'Code: ' + patchResponse.code.to_s
+		p 'Message: ' + patchResponse.message.to_s
+		p 'Result Count: ' + patchResponse.results.length.to_s
+		p 'Results: ' + patchResponse.results.inspect
+    raise 'Failure updating list' unless patchResponse.success?
+    raise 'Failure updating list' unless patchResponse.results.first[:object][:description] == "I updated the description"
+
+		# Retrieve List that should have description updated
+		p '>>> Retrieve List that should have description updated '
+		getList = FuelSDK::ET_List.new()
+		getList.authStub = stubObj
+		getList.props = ["ID","PartnerKey","CreatedDate","ModifiedDate","Client.ID","Client.PartnerClientKey","ListName","Description","Category","Type","CustomerKey","ListClassification","AutomatedEmail.ID"]
+		getList.filter = {'Property' => 'ID','SimpleOperator' => 'equals','Value' => newListID}
+		getResponse = getList.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 Length: ' + getResponse.results.length.to_s
+		p 'Results: ' + getResponse.results.to_s
+    raise 'Failure retrieving list' unless getResponse.success?
+
+		# Delete List
+		p '>>> Delete List'
+		deleteSub = FuelSDK::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?
+
+		# Retrieve List to confirm deletion
+		p '>>> Retrieve List to confirm deletion'
+		getList = FuelSDK::ET_List.new()
+		getList.authStub = stubObj
+		getList.props = ["ID","PartnerKey","CreatedDate","ModifiedDate","Client.ID","Client.PartnerClientKey","ListName","Description","Category","Type","CustomerKey","ListClassification","AutomatedEmail.ID"]
+		getList.filter = {'Property' => 'ID','SimpleOperator' => 'equals','Value' => newListID}
+		getResponse = getList.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 Length: ' + getResponse.results.length.to_s
+		p 'Results: ' + getResponse.results.to_s
+    raise 'Failure retrieving list' unless getResponse.success?
+	end
+
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-list.subscriber.rb

@@ -0,0 +1,97 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	stubObj = FuelSDK::ET_Client.new auth
+
+	# NOTE: These examples only work in accounts where the SubscriberKey functionality is not enabled
+	#       SubscriberKey will need to be included in the props if that feature is enabled
+
+	NewListName = "RubySDKListSubscriber"
+	SubscriberTestEmail = "RubySDKListSubscriber@bh.exacttarget.com"
+
+	# Create List
+	p '>>> Create List'
+	postList = FuelSDK::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 posting list' unless postResponse.success?
+
+
+	# Make sure the list created correctly before
+	if postResponse.success? then
+
+		newListID = postResponse.results[0][:new_id]
+
+		# Create Subscriber On List
+		p '>>> Create Subscriber On List'
+		postSub = FuelSDK::ET_Subscriber.new
+		postSub.authStub = stubObj
+		postSub.props = {"EmailAddress" => SubscriberTestEmail, "Lists" =>[{"ID" => newListID}]}
+		postResponse = postSub.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.success? == false then
+			# If the subscriber already exists in the account then we need to do an update.
+			# Update Subscriber On List
+			if postResponse.results[0][:error_code] == "12014" then
+				# Update Subscriber to add to List
+				p '>>> Update Subscriber to add to List'
+				patchSub = FuelSDK::ET_Subscriber.new
+				patchSub.authStub = stubObj
+				patchSub.props = {"EmailAddress" => SubscriberTestEmail, "Lists" =>[{"ID" => newListID}]}
+				patchResponse = patchSub.patch
+				p 'Patch Status: ' + patchResponse.status.to_s
+				p 'Code: ' + patchResponse.code.to_s
+				p 'Message: ' + patchResponse.message.to_s
+				p 'Result Count: ' + patchResponse.results.length.to_s
+				p 'Results: ' + patchResponse.results.inspect
+        raise 'Failure updating subscriber' unless patchResponse.success?
+			end
+		end
+
+
+		# Retrieve all Subscribers on the List
+		p '>>> Retrieve all Subscribers on the List'
+		getListSubs = FuelSDK::ET_List::Subscriber.new
+		getListSubs.authStub = stubObj
+		getListSubs.props = ["ObjectID","SubscriberKey","CreatedDate","Client.ID","Client.PartnerClientKey","ListID","Status"]
+		getListSubs.filter = {'Property' => 'ListID','SimpleOperator' => 'equals','Value' => newListID}
+		getResponse = getListSubs.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 Length: ' + getResponse.results.length.to_s
+		p 'Results: ' + getResponse.results.to_s
+    raise 'Failure retrieving subscirbers on list' unless getResponse.success?
+
+		# Delete List
+		p '>>> Delete List'
+		deleteSub = FuelSDK::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-openevent.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 OpenEvents with GetMoreResults'
+	getOpenEvent = ET_OpenEvent.new()
+	getOpenEvent.authStub = stubObj
+	getOpenEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
+	getOpenEvent.filter = {'Property' => 'EventDate','SimpleOperator' => 'greaterThan','DateValue' => retrieveDate}
+	getResponse = getOpenEvent.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 OpenEvents with GetMoreResults'
+		getResponse = getOpenEvent.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 OpenEvents with GetMoreResults'
+	getOpenEvent = ET_OpenEvent.new()
+	getOpenEvent.authStub = stubObj
+	getOpenEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
+	getResponse = getOpenEvent.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 OpenEvents with GetMoreResults'
+		getResponse = getOpenEvent.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-sentevent.rb

@@ -0,0 +1,69 @@
+require '../ET_Client.rb'
+require 'securerandom'
+
+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 SentEvents with GetMoreResults'
+	getSentEvent = ET_SentEvent.new()
+	getSentEvent.authStub = stubObj
+	getSentEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","ListID","PartnerKey","SubscriberID"]
+	getSentEvent.filter = {'Property' => 'EventDate','SimpleOperator' => 'greaterThan','DateValue' => retrieveDate}
+	getResponse = getSentEvent.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 SentEvents with GetMoreResults'
+		getResponse = getSentEvent.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 SentEvents with GetMoreResults'
+	getSentEvent = ET_SentEvent.new()
+	getSentEvent.authStub = stubObj
+	getSentEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","ListID","PartnerKey","SubscriberID"]
+	getResponse = getSentEvent.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 SentEvents with GetMoreResults'
+		getResponse = getSentEvent.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-subscriber.rb

@@ -0,0 +1,136 @@
+require 'fuelsdk'
+require_relative 'sample_helper' # contains auth with credentials
+
+begin
+  stubObj = FuelSDK::ET_Client.new auth
+
+  # NOTE: These examples only work in accounts where the SubscriberKey functionality is not enabled
+  #       SubscriberKey will need to be included in the props if that feature is enabled
+
+  SubscriberTestEmail = "RubySDKExample@jb.kevy.com"
+
+  # Create Subscriber
+  p '>>> Create Subscriber'
+  postSub = FuelSDK::ET_Subscriber.new
+  postSub.authStub = stubObj
+  postSub.props = {"EmailAddress" => SubscriberTestEmail}
+  p '>>> Posting'
+  postResponse = postSub.post
+  p "Post Status: #{postResponse.success? ? 'Success' : 'Failure'}"
+  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 subscriber' unless postResponse.success?
+
+  # Retrieve newly created Subscriber
+  p '>>> Retrieve newly created Subscriber'
+  getSub = FuelSDK::ET_Subscriber.new()
+  getSub.authStub = stubObj
+  getSub.props = ["SubscriberKey", "EmailAddress", "Status"]
+  getSub.filter = {'Property' => 'SubscriberKey', 'SimpleOperator' => 'equals', 'Value' => SubscriberTestEmail}
+  getResponse = getSub.get
+  p "Retrieve Status: #{getResponse.success? ? 'Success' : 'Failure'}"
+  p 'Code: ' + getResponse.code.to_s
+  p 'Message: ' + getResponse.message.to_s
+  p 'MoreResults: ' + getResponse.more?.to_s
+  p 'Results Length: ' + getResponse.results.length.to_s
+  p 'Results: ' + getResponse.results.to_s
+
+  raise 'Failure retrieving subscriber' unless getResponse.success?
+
+  # Update Subscriber
+  p '>>> Update Subscriber'
+  patchSub = FuelSDK::ET_Subscriber.new
+  patchSub.authStub = stubObj
+  patchSub.props = {"EmailAddress" => SubscriberTestEmail, "Status" => "Unsubscribed"}
+  patchResponse = patchSub.patch
+  p 'Patch Status: ' + patchResponse.status.to_s
+  p 'Code: ' + patchResponse.code.to_s
+  p 'Message: ' + patchResponse.message.to_s
+  p 'Result Count: ' + patchResponse.results.length.to_s
+  p 'Results: ' + patchResponse.results.inspect
+
+  raise 'Failure updating subscriber' unless patchResponse.success?
+
+  # Retrieve Subscriber that should have status unsubscribed now
+  p '>>> Retrieve Subscriber that should have status unsubscribed now'
+  getSub = FuelSDK::ET_Subscriber.new()
+  getSub.authStub = stubObj
+  getSub.props = ["SubscriberKey", "EmailAddress", "Status"]
+  getSub.filter = {'Property' => 'SubscriberKey','SimpleOperator' => 'equals','Value' => SubscriberTestEmail};
+  getResponse = getSub.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 Length: ' + getResponse.results.length.to_s
+  p 'Results: ' + getResponse.results.to_s
+
+  raise 'Failure retrieving subscriber' unless getResponse.success?
+
+  # Delete Subscriber
+  p '>>> Delete Subscriber'
+  deleteSub = FuelSDK::ET_Subscriber.new()
+  deleteSub.authStub = stubObj
+  deleteSub.props = {"EmailAddress" => SubscriberTestEmail}
+  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 subscriber' unless deleteResponse.success?
+
+  # Retrieve Subscriber to confirm deletion
+  p '>>> Retrieve Subscriber to confirm deletion'
+  getSub = FuelSDK::ET_Subscriber.new()
+  getSub.authStub = stubObj
+  getSub.props = ["SubscriberKey", "EmailAddress", "Status"]
+  getSub.filter = {'Property' => 'SubscriberKey','SimpleOperator' => 'equals','Value' => SubscriberTestEmail};
+  getResponse = getSub.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 Length: ' + getResponse.results.length.to_s
+  p 'Results: ' + getResponse.results.to_s
+
+  raise 'Failure retrieving subscriber' unless getResponse.success?
+
+=begin
+  # Do not run the "Retrieve All Subscribers" request for testing if you have more than 100,000 records in your account as it will take a long time to complete.
+
+  # Retrieve All Subcribers with GetMoreResults
+  p '>>> Retrieve All Subcribers with GetMoreResults'
+  getSub = FuelSDK::ET_Subscriber.new()
+  getSub.authStub = stubObj
+  getSub.props = ["SubscriberKey", "EmailAddress", "Status"]
+  getResponse = getSub.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
+  #p 'Results: ' + getResponse.results.to_s
+
+  while getResponse.more? do
+    p '>>> Continue Retrieve All Subcribers with GetMoreResults'
+    getResponse.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
+