fuelsdk_json_bump 0.0.5

data/samples/sample-clickevent.rb

@@ -0,0 +1,71 @@
+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 = '2013-01-15T13:00:00.000'
+
+	p '>>> Retrieve Filtered ClickEvents with GetMoreResults'
+	getClickEvent = FuelSDK::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.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 click events' unless getResponse.success?
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve Filtered ClickEvents with GetMoreResults'
+		getResponse = getClickEvent.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 ClickEvents with GetMoreResults'
+	getClickEvent = FuelSDK::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.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 ClickEvents with GetMoreResults'
+		getResponse = getClickEvent.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-contentarea.rb

@@ -0,0 +1,122 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+
+begin
+	stubObj = FuelSDK::Client.new auth
+
+	# Retrieve All ContentArea with GetMoreResults
+	p '>>> Retrieve All ContentArea with GetMoreResults'
+	getContent = FuelSDK::ContentArea.new()
+	getContent.authStub = stubObj
+	getContent.props = ["RowObjectID","ObjectID","ID","CustomerKey","Client.ID","ModifiedDate","CreatedDate","CategoryID","Name","Layout","IsDynamicContent","Content","IsSurvey","IsBlank","Key"]
+	getResponse = getContent.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 contentarea' unless getResponse.success?
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve All ContentArea with GetMoreResults'
+		getResponse = getContent.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
+
+	NameOfTestContentArea = "RubySDKContentArea"
+
+	# Create ContentArea
+	p '>>> Create ContentArea'
+	postContent = FuelSDK::ContentArea.new
+	postContent.authStub = stubObj
+	postContent.props = {"CustomerKey" => NameOfTestContentArea, "Name"=>NameOfTestContentArea, "Content"=> "<b>Some HTML Content Goes here</b>"}
+	postResponse = postContent.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 contentarea' unless postResponse.success?
+
+	# Retrieve newly created ContentArea
+	p '>>> Retrieve newly created ContentArea'
+	getContent = FuelSDK::ContentArea.new()
+	getContent.authStub = stubObj
+	getContent.props = ["RowObjectID","ObjectID","ID","CustomerKey","Client.ID","ModifiedDate","CreatedDate","CategoryID","Name","Layout","IsDynamicContent","Content","IsSurvey","IsBlank","Key"]
+	getContent.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestContentArea}
+	getResponse = getContent.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 contentarea' unless getResponse.success?
+
+	# Update ContentArea
+	p '>>> Update ContentArea'
+	patchContent = FuelSDK::ContentArea.new
+	patchContent.authStub = stubObj
+	patchContent.props = {"CustomerKey" => NameOfTestContentArea, "Name"=>NameOfTestContentArea, "Content"=> "<b>Some HTML Content Goes here. NOW WITH NEW CONTENT</b>"}
+	patchResponse = patchContent.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 contentarea' unless patchResponse.success?
+
+	# Retrieve updated ContentArea
+	p '>>> Retrieve updated ContentArea'
+	getContent = FuelSDK::ContentArea.new()
+	getContent.authStub = stubObj
+	getContent.props = ["RowObjectID","ObjectID","ID","CustomerKey","Client.ID","ModifiedDate","CreatedDate","CategoryID","Name","Layout","IsDynamicContent","Content","IsSurvey","IsBlank","Key"]
+	getContent.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestContentArea}
+	getResponse = getContent.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 contentarea' unless getResponse.success?
+
+	# Delete ContentArea
+	p '>>> Delete ContentArea'
+	deleteContent = FuelSDK::ContentArea.new
+	deleteContent.authStub = stubObj
+	deleteContent.props = {"CustomerKey" => NameOfTestContentArea, "Name"=>NameOfTestContentArea, "Content"=> "<b>Some HTML Content Goes here. NOW WITH NEW CONTENT</b>"}
+	deleteResponse = deleteContent.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 contentarea' unless deleteResponse.success?
+
+	# Retrieve ContentArea to confirm deletion
+	p '>>> Retrieve ContentArea to confirm deletion'
+	getContent = FuelSDK::ContentArea.new()
+	getContent.authStub = stubObj
+	getContent.props = ["RowObjectID","ObjectID","ID","CustomerKey","Client.ID","ModifiedDate","CreatedDate","CategoryID","Name","Layout","IsDynamicContent","Content","IsSurvey","IsBlank","Key"]
+	getContent.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestContentArea}
+	getResponse = getContent.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 contentarea' unless getResponse.success?
+
+rescue => e
+	p "Caught exception: #{e.message}"
+	p e.backtrace
+end
+

data/samples/sample-dataextension.rb

@@ -0,0 +1,209 @@
+require 'fuelsdk'
+require_relative 'sample_helper'
+require 'pry'
+
+begin
+	stubObj = ET_Client.new auth
+	
+	# Specify a name for the data extension that will be used for testing
+	# Note: Name and CustomerKey will be the same value
+	# WARNING: Data Extension will be deleted so don't use the name of a
+	# production data extension
+	NameOfDE = "ThisWillBeDeleted-Testz"
+	
+	# Get all of the DataExtensions in an Account
+	p '>>> Get all of the DataExtensions in an Account'
+	de = ET_DataExtension.new
+	de.authStub = stubObj
+	de.props = ["CustomerKey", "Name"]
+	getResponse = de.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
+  raise 'Failure retrieving data extensions' unless getResponse.success?
+
+	# Create  Data Extension
+	p '>>> Create Data Extension'
+	de2 = ET_DataExtension.new
+	de2.authStub = stubObj
+	de2.props = {"Name" => NameOfDE,"CustomerKey" => NameOfDE}
+	de2.columns = [{"Name" => "Name", "FieldType" => "Text", "IsPrimaryKey" => "true", "MaxLength" => "100", "IsRequired" => "true"},
+  {"Name" => "OtherField", "FieldType" => "Text"}]
+	postResponse = de2.post
+	p 'Post Status: ' + postResponse.status.to_s
+	p 'Code: ' + postResponse.code.to_s
+	p 'Message: ' + postResponse.message.to_s
+	p 'Results: ' + postResponse.results.inspect
+  raise 'Failure creating data extension' unless postResponse.success?
+
+	# Update DE to add new field
+	p '>>> Update DE to add new field'
+	de3 = ET_DataExtension.new
+	de3.authStub = stubObj
+	de3.props = {"Name" => NameOfDE,"CustomerKey" => NameOfDE}
+	de3.columns = [{"Name" => "AddedField", "FieldType" => "Text"}]
+	patchResponse = de3.patch
+	p 'Patch Status: ' + patchResponse.status.to_s
+	p 'Code: ' + patchResponse.code.to_s
+	p 'Message: ' + patchResponse.message.to_s
+	p 'Results: ' + patchResponse.results.inspect
+  raise 'Failure updating data extension' unless patchResponse.success?
+
+	# Retrieve all columns for data extension
+	p '>>> Retrieve all columns for data extension '
+	myDEColumn = ET_DataExtension::Column.new
+	myDEColumn.authStub = stubObj
+	myDEColumn.props = ["Name"]
+	myDEColumn.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfDE}
+	getResponse = myDEColumn.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
+  raise 'Failure retrieving data extension columns' unless getResponse.success?
+  raise 'Failure retrieving correct number of data extension columns' unless getResponse.results.count == 3
+
+	# Add a row to a data extension (using CustomerKey)
+	p '>>>  Add a row to a data extension'
+	de4 = ET_DataExtension::Row.new
+	de4.CustomerKey = NameOfDE;
+	de4.authStub = stubObj
+	de4.props = {"Name" => "MAC3", "OtherField" => "Text3"}
+	postResponse = de4.post
+	p 'Post Status: ' + postResponse.status.to_s
+	p 'Code: ' + postResponse.code.to_s
+	p 'Message: ' + postResponse.message.to_s
+	p 'Results: ' + postResponse.results.inspect
+  raise 'Failure creating data extension row' unless postResponse.success?
+
+	# Add a row to a data extension (Using Name)
+	p '>>> Add a row to a data extension'
+	de4 = ET_DataExtension::Row.new
+	de4.authStub = stubObj
+	de4.Name = NameOfDE
+	de4.props = {"Name" => "MAC4", "OtherField" => "Text3"}
+	postResponse = de4.post
+	p 'Post Status: ' + postResponse.status.to_s
+	p 'Code: ' + postResponse.code.to_s
+	p 'Message: ' + postResponse.message.to_s
+	p 'Results: ' + postResponse.results.inspect
+  raise 'Failure creating data extension row' unless postResponse.success?
+
+	# Retrieve all rows
+	p '>>> Retrieve all rows'
+	row = ET_DataExtension::Row.new()
+	row.authStub = stubObj
+	row.CustomerKey = NameOfDE
+	row.props = ["Name","OtherField"]
+	getResponse = row.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
+  raise 'Failure retrieving data extension rows' unless getResponse.success?
+  raise 'Failure retrieving correct number of data extension rows' unless getResponse.results.count == 2
+
+	# Update a row in  a data extension
+	p '>>> Update a row in  a data extension'
+	de4 = ET_DataExtension::Row.new
+	de4.authStub = stubObj
+	de4.CustomerKey = NameOfDE
+	de4.props = {"Name" => "MAC3", "OtherField" => "UPDATED!"}
+	patchResponse = de4.patch
+	p 'Patch Status: ' + patchResponse.status.to_s
+	p 'Code: ' + patchResponse.code.to_s
+	p 'Message: ' + patchResponse.message.to_s
+	p 'Results: ' + patchResponse.results.inspect
+  raise 'Failure updating data extension row' unless patchResponse.success?
+
+	# Retrieve only updated row
+	p '>>> Retrieve only updated row'
+	row = ET_DataExtension::Row.new()
+	row.authStub = stubObj
+	row.CustomerKey = NameOfDE
+	row.props = ["Name","OtherField"]
+	row.filter = {'Property' => 'Name','SimpleOperator' => 'equals','Value' => 'MAC3'}
+	getResponse = row.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
+  raise 'Failure retrieving data extension rows' unless getResponse.success?
+
+	# Delete a row from a data extension
+	p '>>> Delete a row from a data extension'
+	de4 = ET_DataExtension::Row.new
+	de4.authStub = stubObj
+	de4.CustomerKey = NameOfDE
+	de4.props = {"Name" => "MAC3"}
+	deleteResponse = de4.delete
+	p 'Delete Status: ' + deleteResponse.status.to_s
+	p 'Code: ' + deleteResponse.code.to_s
+	p 'Message: ' + deleteResponse.message.to_s
+	p 'Results: ' + deleteResponse.results.inspect
+  raise 'Failure deleting data extension row' unless deleteResponse.success?
+
+	# Delete a Data Extension
+	p '>>> Delete a  Data Extension'
+	de5 = ET_DataExtension.new
+	de5.authStub = stubObj
+	de5.props = {"Name" => NameOfDE,"CustomerKey" => NameOfDE}
+	delResponse = de5.delete
+	p 'Post Status: ' + delResponse.status.to_s
+	p 'Code: ' + delResponse.code.to_s
+	p 'Message: ' + delResponse.message.to_s
+	p 'Results: ' + delResponse.results.inspect
+  raise 'Failure deleting data extension' unless deleteResponse.success?
+
+=begin
+	# Retrieve lots of rows with more?
+	p '>>> Retrieve lots of rows with more?'
+	row = ET_DataExtension::Row.new()
+	row.authStub = stubObj
+	row.Name = "zipstolong"
+	row.props = ["zip","latitude","longitude"]
+	getResponse = row.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
+  raise 'Failure retrieving data extension rows' unless getResponse.success?
+
+	while getResponse.more? do
+		p '>>> Continue Retrieve lots of rows with more?'
+		getResponse = row.getMoreResults
+		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
+
+  de5 = ET_DataExtension.new
+  de5.authStub = stubObj
+  de5.props = {"Name" => NameOfDE,"CustomerKey" => NameOfDE}
+  de5.delete
+
+end

data/samples/sample-directverb.rb

@@ -0,0 +1,55 @@
+require 'fuelsdk'
+require_relative 'sample_helper' # contains auth with credentials
+
+begin
+  filter = {'Property' =>  'Type','SimpleOperator' => 'equals','Value' => 'Public'}  
+  client = ET_Client.new auth 
+  getResponse = ET_Get.new client, 'List', nil, filter
+  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 List info' unless getResponse.success?
+    
+  NewListName = "RubySDKList"
+  props = {"ListName" => NewListName, "Description" => "This list was created with the RubySDK", "Type" => "Private" }
+  client = ET_Client.new auth 
+  postResponse = ET_Post.new client, 'List', props
+  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.success? then		
+		newListID = postResponse.results[0][:new_id]
+		p "New ID: #{newListID}"
+		
+		props = {"ID" => newListID, "Description" => "Update!!!"}
+		client = ET_Client.new auth 
+		patchResponse = ET_Patch.new client, 'List', props
+		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 Patching List' unless patchResponse.success?
+		
+		
+		props = {"ID" => newListID}
+		client = ET_Client.new auth 
+		deleteResponse = ET_Delete.new client, 'List', props
+		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 List' unless deleteResponse.success?
+	end 
+
+rescue => e
+  p "Caught exception: #{e.message}"
+  p e.backtrace
+end