sfmc-fuelsdk-ruby 1.1.0

data/samples/sample-email.senddefinition.rb

@@ -0,0 +1,134 @@
+require 'marketingcloudsdk'
+require_relative 'sample_helper'
+
+begin
+	stubObj = MarketingCloudSDK::Client.new auth
+	
+	NewSendDefinitionName = "PHPSDKSendDefinition";
+	SendableDataExtensionCustomerKey = "F6F3871A-D124-499B-BBF5-3EFC0E827A51";
+	EmailIDForSendDefinition = "3113962";
+	ListIDForSendDefinition = "1729515";
+	SendClassificationCustomerKey = "2239";
+
+	# Retrieve All Email::SendDefinition with GetMoreResults
+	p '>>> Retrieve All Email.SendDefinition with GetMoreResults'
+	sendDef = MarketingCloudSDK::Email::SendDefinition.new()
+	sendDef.authStub = stubObj
+	sendDef.props = ["Client.ID", "CreatedDate","ModifiedDate","ObjectID","CustomerKey","Name","CategoryID","Description","SendClassification.CustomerKey","SenderProfile.CustomerKey","SenderProfile.FromName","SenderProfile.FromAddress","DeliveryProfile.CustomerKey","DeliveryProfile.SourceAddressType","DeliveryProfile.PrivateIP","DeliveryProfile.DomainType","DeliveryProfile.PrivateDomain","DeliveryProfile.HeaderSalutationSource","DeliveryProfile.FooterSalutationSource","SuppressTracking","IsSendLogging","Email.ID","BccEmail","AutoBccEmail","TestEmailAddr","EmailSubject","DynamicEmailSubject","IsMultipart","IsWrapped","SendLimit","SendWindowOpen","SendWindowClose","DeduplicateByEmail","ExclusionFilter","Additional"]
+	getResponse = sendDef.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 SendDefinition' unless getResponse.success?
+  
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve All Email with GetMoreResults'
+		getResponse = getHTMLBody.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
+
+	p '>>> Create New Email.SendDefinition to DataExtension'
+	postSendDefinition = MarketingCloudSDK::Email::SendDefinition.new()
+	postSendDefinition.authStub = stubObj	
+	postSendDefinition.props = {}
+	postSendDefinition.props["Name"] = NewSendDefinitionName
+	postSendDefinition.props["CustomerKey"] = NewSendDefinitionName
+	postSendDefinition.props["Description"]  = "Created with RubySDK"
+	postSendDefinition.props["SendClassification"] = {"CustomerKey"=>SendClassificationCustomerKey}
+	postSendDefinition.props["SendDefinitionList"] = {"CustomerKey"=> SendableDataExtensionCustomerKey, "DataSourceTypeID"=>"CustomObject"}
+	postSendDefinition.props["Email"] = {"ID"=>EmailIDForSendDefinition}
+	postResponse = postSendDefinition.post
+	p 'Post Status: ' + postResponse.status.to_s
+	p 'Code: ' + postResponse.code.to_s
+	p 'Message: ' + postResponse.message.to_s
+	p 'MoreResults: ' + postResponse.more?.to_s
+	p 'Results Length: ' + postResponse.results.length.to_s
+	p 'Results: ' + postResponse.results.to_s
+	#raise 'Failure Creating SendDefinition' unless postResponse.success?
+
+	p '>>> Delete SendDefinition to DataExtension'
+	deleteSendDefinition = MarketingCloudSDK::Email::SendDefinition.new()
+	deleteSendDefinition.authStub = stubObj	
+	deleteSendDefinition.props = {"CustomerKey"=> NewSendDefinitionName}
+	deleteResponse = deleteSendDefinition.delete
+	p 'Delete Status: ' + deleteResponse.status.to_s
+	p 'Code: ' + deleteResponse.code.to_s
+	p 'Message: ' + deleteResponse.message.to_s
+	p 'MoreResults: ' + deleteResponse.more?.to_s
+	p 'Results Length: ' + deleteResponse.results.length.to_s
+	p 'Results: ' + deleteResponse.results.to_s
+	#raise 'Failure Deleting SendDefinition' unless deleteResponse.success?
+	
+	
+	p '>>> Create New Email.SendDefinition to List'
+	postSendDefinition = MarketingCloudSDK::Email::SendDefinition.new()
+	postSendDefinition.authStub = stubObj	
+	postSendDefinition.props = {"Name"=>NewSendDefinitionName}
+	postSendDefinition.props["CustomerKey"] = NewSendDefinitionName
+	postSendDefinition.props["Description"]  = "Created with PHPSDK"
+	postSendDefinition.props["SendClassification"] = {"CustomerKey"=>SendClassificationCustomerKey}
+	postSendDefinition.props["SendDefinitionList"] = {"List"=> {"ID"=>ListIDForSendDefinition}, "DataSourceTypeID"=>"List"}
+	postSendDefinition.props["Email"] = {"ID"=>EmailIDForSendDefinition}
+	postResponse = postSendDefinition.post
+	p 'Post Status: ' + postResponse.status.to_s
+	p 'Code: ' + postResponse.code.to_s
+	p 'Message: ' + postResponse.message.to_s
+	p 'MoreResults: ' + postResponse.more?.to_s
+	p 'Results Length: ' + postResponse.results.length.to_s
+	p 'Results: ' + postResponse.results.to_s
+	raise 'Failure Creating SendDefinition' unless postResponse.success?
+	
+	p '>>> Send SendDefinition to List'
+	sendSendDefinition = MarketingCloudSDK::Email::SendDefinition.new()
+	sendSendDefinition.authStub = stubObj	
+	sendSendDefinition.props = {"CustomerKey"=> NewSendDefinitionName}
+	sendResponse = sendSendDefinition.send
+	p 'Send Status: ' + sendResponse.status.to_s
+	p 'Code: ' + sendResponse.code.to_s
+	p 'Message: ' + sendResponse.message.to_s
+	p 'MoreResults: ' + sendResponse.more?.to_s
+	p 'Results Length: ' + sendResponse.results.length.to_s
+	p 'Results: ' + sendResponse.results.to_s
+	raise 'Failure Sending SendDefinition' unless sendResponse.success?
+	
+	emailStatus = ""
+	while emailStatus != "Canceled" && emailStatus != "Complete" do
+		p '>>> Checking status in loop'
+		# Wait a bit before checking the status to give it time to process
+		sleep 10
+		statusResponse = sendSendDefinition.status
+		p 'Status Status: ' + statusResponse.status.to_s
+		p 'Code: ' + statusResponse.code.to_s
+		p 'Message: ' + statusResponse.message.to_s
+		p 'Result Count: ' + statusResponse.results.length.to_s
+		p 'Results: ' + statusResponse.results.inspect
+		emailStatus = statusResponse.results[0][:status]
+	end
+	
+	p '>>> Delete SendDefinition to List'
+	deleteSendDefinition = MarketingCloudSDK::Email::SendDefinition.new()
+	deleteSendDefinition.authStub = stubObj	
+	deleteSendDefinition.props = {"CustomerKey"=> NewSendDefinitionName}
+	deleteResponse = deleteSendDefinition.delete
+	p 'Delete Status: ' + deleteResponse.status.to_s
+	p 'Code: ' + deleteResponse.code.to_s
+	p 'Message: ' + deleteResponse.message.to_s
+	p 'MoreResults: ' + deleteResponse.more?.to_s
+	p 'Results Length: ' + deleteResponse.results.length.to_s
+	p 'Results: ' + deleteResponse.results.to_s
+	raise 'Failure Deleting SendDefinition' unless deleteResponse.success?
+	
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-folder.rb

@@ -0,0 +1,143 @@
+require 'marketingcloudsdk'
+require_relative 'sample_helper'
+
+begin
+	stubObj = MarketingCloudSDK::Client.new auth
+
+	# Retrieve All Folder with GetMoreResults
+	p '>>> Retrieve All Folder with GetMoreResults'
+	getFolder = MarketingCloudSDK::Folder.new()
+	getFolder.authStub = stubObj
+	getFolder.props = ["ID", "Client.ID", "ParentFolder.ID", "ParentFolder.CustomerKey", "ParentFolder.ObjectID", "ParentFolder.Name", "ParentFolder.Description", "ParentFolder.ContentType", "ParentFolder.IsActive", "ParentFolder.IsEditable", "ParentFolder.AllowChildren", "Name", "Description", "ContentType", "IsActive", "IsEditable", "AllowChildren", "CreatedDate", "ModifiedDate", "Client.ModifiedBy", "ObjectID", "CustomerKey", "Client.EnterpriseID", "Client.CreatedBy"]
+	getResponse = getFolder.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 Folders' unless getResponse.success?
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve All Folder 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
+
+	NameOfTestFolder = "RubySDKFolder"
+
+	# Retrieve Specific Folder for Email Folder ParentID
+	p '>>> Retrieve Specific Folder for Email Folder ParentID'
+	getFolder = MarketingCloudSDK::Folder.new()
+	getFolder.authStub = stubObj
+	getFolder.props = ["ID"]
+	getFolder.filter = {'LeftOperand' => {'Property' => 'ParentFolder.ID','SimpleOperator' => 'equals','Value' => '0'}, 'LogicalOperator' => 'AND', 'RightOperand' => {'Property' => 'ContentType','SimpleOperator' => 'equals','Value' => 'EMAIL'}}
+	getResponse = getFolder.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 Folder' unless getResponse.success?
+
+	if getResponse.success? then
+		ParentIDForEmail = getResponse.results[0][:id]
+		p "Parent Folder for Email: #{ParentIDForEmail}"
+
+		# Create Folder
+		p '>>> Create Folder'
+		postFolder = MarketingCloudSDK::Folder.new
+		postFolder.authStub = stubObj
+		postFolder.props = {"CustomerKey" => NameOfTestFolder, "Name" => NameOfTestFolder, "Description" => NameOfTestFolder, "ContentType"=> "EMAIL", "ParentFolder" => {"ID" => ParentIDForEmail}}
+		postResponse = postFolder.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 Folder' unless postResponse.success?
+
+		# Retrieve newly created Folder
+		p '>>> Retrieve newly created Folder'
+		getFolder = MarketingCloudSDK::Folder.new()
+		getFolder.authStub = stubObj
+		getFolder.props = ["ID", "Client.ID", "ParentFolder.ID", "ParentFolder.CustomerKey", "ParentFolder.ObjectID", "ParentFolder.Name", "ParentFolder.Description", "ParentFolder.ContentType", "ParentFolder.IsActive", "ParentFolder.IsEditable", "ParentFolder.AllowChildren", "Name", "Description", "ContentType", "IsActive", "IsEditable", "AllowChildren", "CreatedDate", "ModifiedDate", "Client.ModifiedBy", "ObjectID", "CustomerKey", "Client.EnterpriseID", "Client.CreatedBy"]
+		getFolder.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestFolder}
+		getResponse = getFolder.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 Folder' unless getResponse.success?
+    raise 'Failure verifying created Folder' if getResponse.results.empty?
+
+		# Update Folder
+		p '>>> Update Folder'
+		patchFolder = MarketingCloudSDK::Folder.new
+		patchFolder.authStub = stubObj
+		patchFolder.props = {"CustomerKey" => NameOfTestFolder, "Description" => "New Description"}
+		patchResponse = patchFolder.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 Folder' unless patchResponse.success?
+
+		# Retrieve updated Folder
+		p '>>> Retrieve updated Folder'
+		getFolder = MarketingCloudSDK::Folder.new()
+		getFolder.authStub = stubObj
+		getFolder.props = ["ID", "Client.ID", "ParentFolder.ID", "ParentFolder.CustomerKey", "ParentFolder.ObjectID", "ParentFolder.Name", "ParentFolder.Description", "ParentFolder.ContentType", "ParentFolder.IsActive", "ParentFolder.IsEditable", "ParentFolder.AllowChildren", "Name", "Description", "ContentType", "IsActive", "IsEditable", "AllowChildren", "CreatedDate", "ModifiedDate", "Client.ModifiedBy", "ObjectID", "CustomerKey", "Client.EnterpriseID", "Client.CreatedBy"]
+		getFolder.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestFolder}
+		getResponse = getFolder.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 Folder' unless getResponse.success?
+
+		# Delete Folder
+		p '>>> Delete Folder'
+		deleteFolder = MarketingCloudSDK::Folder.new
+		deleteFolder.authStub = stubObj
+		deleteFolder.props = {"CustomerKey" => NameOfTestFolder, "Name"=>NameOfTestFolder, "Content"=> "<b>Some HTML Content Goes here. NOW WITH NEW CONTENT</b>"}
+		deleteResponse = deleteFolder.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 Folder' unless deleteResponse.success?
+
+		# Retrieve Folder to confirm deletion
+		p '>>> Retrieve Folder to confirm deletion'
+		getFolder = MarketingCloudSDK::Folder.new()
+		getFolder.authStub = stubObj
+		getFolder.props = ["ID"]
+		getFolder.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestFolder}
+		getResponse = getFolder.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 verifying deleted Folder' unless getResponse.success?
+    raise 'Failure verifying deleted Folder' unless getResponse.results.empty?
+	end
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-import.rb

@@ -0,0 +1,103 @@
+require 'marketingcloudsdk'
+require_relative 'sample_helper'
+
+begin
+  stubObj = MarketingCloudSDK::Client.new auth
+ 
+  NewImportName = "RubySDKImport"
+  SendableDataExtensionCustomerKey = "62476204-bfd3-de11-95ca-001e0bbae8cc"
+  ListIDForImport = "1956035"
+  
+  p '>>> Create Import to DataExtension'
+  postImport = ET_Import.new
+  postImport.authStub = stubObj
+  postImport.props = {"Name"=>NewImportName}
+  postImport.props["CustomerKey"] = NewImportName
+  postImport.props["Description"] = "Created with RubySDK"
+  postImport.props["AllowErrors"] = "true"
+  postImport.props["DestinationObject"] = {"ObjectID"=>SendableDataExtensionCustomerKey}
+  postImport.props["FieldMappingType"] = "InferFromColumnHeadings"
+  postImport.props["FileSpec"] = "RubyExample.csv"
+  postImport.props["FileType"] = "CSV"
+  postImport.props["Notification"] = {"ResponseType"=>"email","ResponseAddress"=>"example@example.com"}
+  postImport.props["RetrieveFileTransferLocation"] = {"CustomerKey"=>"ExactTarget Enhanced FTP"}
+  postImport.props["UpdateType"] = "Overwrite"
+  postResponse = postImport.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 '>>> Delete Import'
+  deleteImport = ET_Import.new()
+  deleteImport.authStub = stubObj
+  deleteImport.props = {"CustomerKey" => NewImportName}
+  deleteResponse = deleteImport.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
+  
+  p '>>> Create Import to List'
+  postImport = ET_Import.new 
+  postImport.authStub = stubObj
+  postImport.props = {"Name"=>NewImportName}
+  postImport.props["CustomerKey"] = NewImportName
+  postImport.props["Description"] = "Created with RubySDK"
+  postImport.props["AllowErrors"] = "true"
+  postImport.props["DestinationObject"] = {"ID"=>ListIDForImport}
+  postImport.props["FieldMappingType"] = "InferFromColumnHeadings"
+  postImport.props["FileSpec"] = "RubyExample.csv"
+  postImport.props["FileType"] = "CSV"
+  postImport.props["Notification"] = {"ResponseType"=>"email","ResponseAddress"=>"example@example.com"}
+  postImport.props["RetrieveFileTransferLocation"] = {"CustomerKey"=>"ExactTarget Enhanced FTP"}
+  postImport.props["UpdateType"] = "AddAndUpdate"
+  postResponse = postImport.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 '>>> Start Import to List'
+  startImport = ET_Import.new
+  startImport.authStub = stubObj
+  startImport.props = {"CustomerKey"=>NewImportName}
+  postResponse = startImport.start
+  p 'Start 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
+  
+  importStatus = ""
+  while postResponse.status && importStatus != "Error" && importStatus != "Completed" do
+    p '>>> Checking status in loop'
+    # Wait a bit before checking the status to give it time to process
+    sleep 30
+    statusResponse = startImport.status
+    p 'Status Status: ' + statusResponse.status.to_s
+    p 'Code: ' + statusResponse.code.to_s
+    p 'Message: ' + statusResponse.message.to_s
+    p 'Result Count: ' + statusResponse.results.length.to_s
+    p 'Results: ' + statusResponse.results.inspect
+    importStatus = statusResponse.results[0][:import_status]
+  end
+  
+  p '>>> Delete Import'
+  deleteImport = ET_Import.new()
+  deleteImport.authStub = stubObj
+  deleteImport.props = {"CustomerKey" => NewImportName}
+  deleteResponse = deleteImport.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
+    
+rescue => e
+  p "Caught exception: #{e.message}"
+  p e.backtrace
+end

data/samples/sample-list.rb

@@ -0,0 +1,105 @@
+require 'marketingcloudsdk'
+require_relative 'sample_helper'
+
+begin
+	stubObj = MarketingCloudSDK::Client.new auth
+
+	NewListName = "RubySDKList"
+
+	# Create List
+	p '>>> Create List'
+	postList = MarketingCloudSDK::List.new
+	postList.authStub = stubObj
+	postList.props = {"ListName" => NewListName, "Description" => "This list was created with the RubySDK", "Type" => "Private" }
+	#postList.folder_id = 1083760
+	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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 'marketingcloudsdk'
+require_relative 'sample_helper'
+
+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
+
+	NewListName = "RubySDKListSubscriber"
+	SubscriberTestEmail = "RubySDKListSubscriber@bh.exacttarget.com"
+
+	# Create List
+	p '>>> Create List'
+	postList = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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 = MarketingCloudSDK::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,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 OpenEvents with GetMoreResults'
+	getOpenEvent = MarketingCloudSDK::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.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 open events' unless getResponse.success?
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve Filtered OpenEvents with GetMoreResults'
+		getResponse = getOpenEvent.contine
+		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 OpenEvents with GetMoreResults'
+	getOpenEvent = MarketingCloudSDK::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.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 OpenEvents with GetMoreResults'
+		getResponse = getOpenEvent.contine
+		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
+