sfmc-fuelsdk-ruby 1.1.0

data/samples/sample-profileattribute.rb

@@ -0,0 +1,56 @@
+require 'marketingcloudsdk'
+require_relative 'sample_helper'
+
+begin
+  stubObj = MarketingCloudSDK::Client.new auth
+  
+  NameOfAttribute = 'RubySDKTesting'
+  
+  p '>>> Retrieve Profile Attribute'
+  getProfileAttribute = ET_ProfileAttribute.new
+  getProfileAttribute.authStub = stubObj
+  getResponse = getProfileAttribute.get
+  p 'Get Status: ' + getResponse.status.to_s
+  p 'Code: ' + getResponse.code.to_s
+  p 'Message: ' + getResponse.message.to_s
+  p 'Result Count: ' + getResponse.results.length.to_s
+  # p 'Results: ' + getResponse.results.inspect
+  raise 'Failure getting Profile Attribute' unless getResponse.success?
+  
+  p '>>> Create ProfileAttribute'
+  postProfileAttribute = ET_ProfileAttribute.new
+  postProfileAttribute.authStub = stubObj
+  postProfileAttribute.props = {"Name" => NameOfAttribute, "PropertyType"=>"string", "Description"=>"New Attribute from the SDK", "IsRequired"=>"false", "IsViewable"=>"false", "IsEditable"=>"true", "IsSendTime"=>"false"}
+  postResponse = postProfileAttribute.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
+  
+  p '>>> Update ProfileAttribute'
+  patchProfileAttribute = ET_ProfileAttribute.new
+  patchProfileAttribute.authStub = stubObj
+  patchProfileAttribute.props = {"Name" => NameOfAttribute, "PropertyType"=>"string"}
+  patchResponse = patchProfileAttribute.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
+  
+  p '>>> Delete ProfileAttribute'
+  deleteProfileAttribute = ET_ProfileAttribute.new
+  deleteProfileAttribute.authStub = stubObj
+  deleteProfileAttribute.props = {"Name" => NameOfAttribute}
+  deleteResponse = deleteProfileAttribute.delete
+  p 'Delete Status: ' + deleteResponse.status.to_s
+  p 'Code: ' + deleteResponse.code.to_s
+  p 'Message: ' + deleteResponse.message.to_s
+  p 'Result Count: ' + deleteResponse.results.length.to_s
+  p 'Results: ' + deleteResponse.results.inspect
+
+rescue => e
+  p "Caught exception: #{e.message}"
+  p e.backtrace
+end

data/samples/sample-sentevent.rb

@@ -0,0 +1,70 @@
+require 'marketingcloudsdk'
+require_relative 'sample_helper'
+
+begin
+	stubObj = MarketingCloudSDK::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 = '2013-01-15T13:00:00.000'
+
+	p '>>> Retrieve Filtered SentEvents with GetMoreResults'
+	getSentEvent = MarketingCloudSDK::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.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 sent events' unless getResponse.success?
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve Filtered SentEvents with GetMoreResults'
+		getResponse = getSentEvent.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 SentEvents with GetMoreResults'
+	getSentEvent = MarketingCloudSDK::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.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 SentEvents with GetMoreResults'
+		getResponse = getSentEvent.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
+

data/samples/sample-subscriber.rb

@@ -0,0 +1,135 @@
+require 'marketingcloudsdk'
+require_relative 'sample_helper' # contains auth with credentials
+
+begin
+  stubObj = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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

data/samples/sample-triggeredsend.rb

@@ -0,0 +1,129 @@
+require 'marketingcloudsdk'
+require 'securerandom'
+require_relative 'sample_helper'
+
+begin
+	stubObj = MarketingCloudSDK::Client.new auth
+
+	# Get all TriggeredSendDefinitions
+	p '>>> Get all TriggeredSendDefinitions'
+	getTS = MarketingCloudSDK::TriggeredSend.new
+	getTS.authStub = stubObj
+	getTS.props = ["CustomerKey", "Name", "TriggeredSendStatus"]
+	getResponse = getTS.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 Count: ' + getResponse.results.length.to_s
+	#p 'Results: ' + getResponse.results.to_s
+  raise 'Failure retrieving triggersend' unless getResponse.success?
+
+	# Generate a unique identifier for the TriggeredSend customer key since they cannot be re-used even after deleted
+	TSNameForCreateThenDelete = SecureRandom.uuid
+
+	# Create a TriggeredSend Definition
+	p '>>> Create a TriggeredSend Definition'
+	postTrig = MarketingCloudSDK::TriggeredSend.new
+	postTrig.authStub = stubObj
+	postTrig.props = {'CustomerKey' => TSNameForCreateThenDelete,'Name' => TSNameForCreateThenDelete, 'Email' => {"ID"=>"3113962"}, "SendClassification"=> {"CustomerKey"=> "2240"}}
+	postResponse = postTrig.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 triggersend' unless postResponse.success?
+
+	# Specify the name of a TriggeredSend that was setup for testing
+	# Do not use a production Triggered Send Definition
+
+	NameOfTestTS = "TEXTEXT"
+
+	# Pause a TriggeredSend
+	p '>>> Pause a TriggeredSend'
+	patchTrig = MarketingCloudSDK::TriggeredSend.new
+	patchTrig.authStub = stubObj
+	patchTrig.props = {"CustomerKey" => NameOfTestTS, "TriggeredSendStatus" =>"Inactive"}
+	patchResponse = patchTrig.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 triggersend' unless patchResponse.success?
+
+	# Retrieve Single TriggeredSend
+	p '>>> Retrieve Single TriggeredSend'
+	getTS = MarketingCloudSDK::TriggeredSend.new
+	getTS.authStub = stubObj
+	getTS.props = ["CustomerKey", "Name", "TriggeredSendStatus"]
+	getTS.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestTS}
+	getResponse = getTS.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 Count: ' + getResponse.results.length.to_s
+	p 'Results: ' + getResponse.results.to_s
+  raise 'Failure retrieving triggersend' unless getResponse.success?
+
+	# Start a TriggeredSend by setting to Active
+	p '>>> Start a TriggeredSend by setting to Active'
+	patchTrig = MarketingCloudSDK::TriggeredSend.new
+	patchTrig.authStub = stubObj
+	patchTrig.props = {"CustomerKey" => NameOfTestTS, "TriggeredSendStatus" =>"Active"}
+	patchResponse = patchTrig.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 triggersend' unless patchResponse.success?
+
+	# Retrieve Single TriggeredSend After setting back to active
+	p '>>> Retrieve Single TriggeredSend After setting back to active'
+	getTS = MarketingCloudSDK::TriggeredSend.new
+	getTS.authStub = stubObj
+	getTS.props = ["CustomerKey", "Name", "TriggeredSendStatus"]
+	getTS.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestTS}
+	getResponse = getTS.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 Count: ' + getResponse.results.length.to_s
+	p 'Results: ' + getResponse.results.to_s
+  raise 'Failure retrieving triggersend' unless getResponse.success?
+
+	# Send an email with TriggeredSend
+	p '>>> Send an email with TriggeredSend'
+	sendTrig = MarketingCloudSDK::TriggeredSend.new
+	sendTrig.authStub = stubObj
+	sendTrig.props = [{"CustomerKey" => NameOfTestTS, "Subscribers" => {"EmailAddress"=>"testing@bh.exacttarget.com", "SubscriberKey" => "testing@bh.exacttarget.com"}}]
+	sendResponse = sendTrig.send
+	p 'Send Status: ' + sendResponse.status.to_s
+	p 'Code: ' + sendResponse.code.to_s
+	p 'Message: ' + sendResponse.message.to_s
+	p 'Result Count: ' + sendResponse.results.length.to_s
+	p 'Results: ' + sendResponse.results.inspect
+  raise 'Failure sending triggersend' unless sendResponse.success?
+
+
+	# Delete a TriggeredSend Definition
+	p '>>> Delete a TriggeredSend Definition '
+	deleteTrig = MarketingCloudSDK::TriggeredSend.new
+	deleteTrig.authStub = stubObj
+	deleteTrig.props = {'CustomerKey' => TSNameForCreateThenDelete}
+	deleteResponse = deleteTrig.delete
+	p 'Delete Status: ' + deleteResponse.status.to_s
+	p 'Code: ' + deleteResponse.code.to_s
+	p 'Message: ' + deleteResponse.message.to_s
+	p 'Result Count: ' + deleteResponse.results.length.to_s
+	p 'Results: ' + deleteResponse.results.inspect
+  raise 'Failure deleting triggersend' unless deleteResponse.success?
+
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end

data/samples/sample-unsubevent.rb

@@ -0,0 +1,72 @@
+require 'marketingcloudsdk'
+require_relative 'sample_helper'
+
+begin
+	stubObj = MarketingCloudSDK::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 = '2013-01-15T13:00:00.000'
+
+	p '>>> Retrieve Filtered UnsubEvents with GetMoreResults'
+	getUnsubEvent = MarketingCloudSDK::UnsubEvent.new()
+	getUnsubEvent.authStub = stubObj
+	getUnsubEvent.props = ["SendID","SubscriberKey","EventDate",
+  "Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
+	getUnsubEvent.filter = {'Property' => 'EventDate',
+  'SimpleOperator' => 'greaterThan','DateValue' => retrieveDate}
+	getResponse = getUnsubEvent.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 unsub events' unless getResponse.success?
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve Filtered UnsubEvents with GetMoreResults'
+		getResponse = getUnsubEvent.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 UnsubEvents with GetMoreResults'
+	getUnsubEvent = MarketingCloudSDK::UnsubEvent.new()
+	getUnsubEvent.authStub = stubObj
+	getUnsubEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
+	getResponse = getUnsubEvent.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 UnsubEvents with GetMoreResults'
+		getResponse = getUnsubEvent.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
+

data/samples/sample_helper.rb.template

@@ -0,0 +1,10 @@
+def auth
+  {
+    'client' => {
+      'id' => YOURID,
+      'secret' => YOURSERET,
+      'base_api_url' => 'https://www.exacttargetapis.com',
+      'request_token_url' => 'https://auth.exacttargetapis.com/v1/requestToken'
+    }
+  }
+end