marketingcloudsdk 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (57) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +26 -0
  3. data/Gemfile +3 -0
  4. data/Gemfile.lock +92 -0
  5. data/Guardfile +8 -0
  6. data/LICENSE.md +13 -0
  7. data/README.md +130 -0
  8. data/Rakefile +1 -0
  9. data/lib/marketingcloudsdk.rb +74 -0
  10. data/lib/marketingcloudsdk/client.rb +283 -0
  11. data/lib/marketingcloudsdk/http_request.rb +113 -0
  12. data/lib/marketingcloudsdk/objects.rb +757 -0
  13. data/lib/marketingcloudsdk/rest.rb +122 -0
  14. data/lib/marketingcloudsdk/soap.rb +288 -0
  15. data/lib/marketingcloudsdk/targeting.rb +58 -0
  16. data/lib/marketingcloudsdk/utils.rb +47 -0
  17. data/lib/marketingcloudsdk/version.rb +39 -0
  18. data/lib/new.rb +1240 -0
  19. data/marketingcloudsdk.gemspec +30 -0
  20. data/samples/sample-AddSubscriberToList.rb +56 -0
  21. data/samples/sample-CreateAndStartDataExtensionImport.rb +29 -0
  22. data/samples/sample-CreateAndStartListImport.rb +27 -0
  23. data/samples/sample-CreateContentAreas.rb +48 -0
  24. data/samples/sample-CreateDataExtensions.rb +54 -0
  25. data/samples/sample-CreateProfileAttributes.rb +48 -0
  26. data/samples/sample-SendEmailToDataExtension.rb +23 -0
  27. data/samples/sample-SendEmailToList.rb +23 -0
  28. data/samples/sample-SendTriggeredSends.rb +30 -0
  29. data/samples/sample-bounceevent.rb +70 -0
  30. data/samples/sample-campaign.rb +211 -0
  31. data/samples/sample-clickevent.rb +71 -0
  32. data/samples/sample-contentarea.rb +122 -0
  33. data/samples/sample-dataextension.rb +209 -0
  34. data/samples/sample-directverb.rb +55 -0
  35. data/samples/sample-email.rb +122 -0
  36. data/samples/sample-email.senddefinition.rb +134 -0
  37. data/samples/sample-folder.rb +143 -0
  38. data/samples/sample-import.rb +104 -0
  39. data/samples/sample-list.rb +105 -0
  40. data/samples/sample-list.subscriber.rb +97 -0
  41. data/samples/sample-openevent.rb +70 -0
  42. data/samples/sample-profileattribute.rb +57 -0
  43. data/samples/sample-sentevent.rb +70 -0
  44. data/samples/sample-subscriber.rb +136 -0
  45. data/samples/sample-triggeredsend.rb +130 -0
  46. data/samples/sample-unsubevent.rb +72 -0
  47. data/samples/sample_helper.rb.template +8 -0
  48. data/spec/client_spec.rb +210 -0
  49. data/spec/helper_funcs_spec.rb +11 -0
  50. data/spec/http_request_spec.rb +36 -0
  51. data/spec/objects_helper_spec.rb +32 -0
  52. data/spec/objects_spec.rb +484 -0
  53. data/spec/rest_spec.rb +48 -0
  54. data/spec/soap_spec.rb +140 -0
  55. data/spec/spec_helper.rb +14 -0
  56. data/spec/targeting_spec.rb +39 -0
  57. metadata +260 -0
@@ -0,0 +1,211 @@
1
+ require 'fuelsdk'
2
+ require_relative 'sample_helper'
3
+
4
+
5
+ begin
6
+ stubObj = FuelSDK::Client.new auth
7
+
8
+ # Create List
9
+ p '>>> Create List'
10
+ postList = FuelSDK::List.new
11
+ postList.authStub = stubObj
12
+ postList.props = {"ListName" => 'RubyAssetList', "Description" => "This list was created with the RubySDK", "Type" => "Private" }
13
+ postResponse = postList.post
14
+ p 'Post Status: ' + postResponse.status.to_s
15
+ p 'Code: ' + postResponse.code.to_s
16
+ p 'Message: ' + postResponse.message.to_s
17
+ p 'Result Count: ' + postResponse.results.length.to_s
18
+ p 'Results: ' + postResponse.results.inspect
19
+
20
+ raise 'Failure creating list for asset' unless postResponse.success?
21
+
22
+ # In order for this sample to run, it needs to have an asset that it can associate the campaign to
23
+ ExampleAssetType = "LIST"
24
+ ExampleAssetItemID = postResponse.results[0][:new_id]
25
+
26
+ # Retrieve all Campaigns
27
+ p '>>> Retrieve all Campaigns'
28
+ getCamp = FuelSDK::Campaign.new
29
+ getCamp.authStub = stubObj
30
+ getResponse = getCamp.get
31
+ p 'Retrieve Status: ' + getResponse.status.to_s
32
+ p 'Code: ' + getResponse.code.to_s
33
+ p 'Message: ' + getResponse.message.to_s
34
+ p 'MoreResults: ' + getResponse.more?.to_s
35
+ p "Results: #{getResponse.results}"
36
+ p 'Results(Items) Length: ' + getResponse.results['items'].length.to_s
37
+ p '-----------------------------'
38
+
39
+ raise 'Failure retrieving campaigns' unless getResponse.success?
40
+
41
+ while getResponse.more? do
42
+ p '>>> Continue Retrieve all Campaigns with GetMoreResults'
43
+ getResponse = getCamp.continue
44
+ p 'Retrieve Status: ' + getResponse.status.to_s
45
+ p 'Code: ' + getResponse.code.to_s
46
+ p 'Message: ' + getResponse.message.to_s
47
+ p 'MoreResults: ' + getResponse.more?.to_s
48
+ p 'Results(Items) Length: ' + getResponse.results['items'].length.to_s
49
+ end
50
+
51
+ # Create a new Campaign
52
+ p '>>> Create a new Campaign'
53
+ postCamp = FuelSDK::Campaign.new
54
+ postCamp.authStub = stubObj
55
+ postCamp.props = {"name" => "RubySDKCreatedForTest1", "description"=> "RubySDKCreatedForTest", "color"=>"FF9933", "favorite"=>"false"}
56
+ postResponse = postCamp.post
57
+ p 'Post Status: ' + postResponse.status.to_s
58
+ p 'Code: ' + postResponse.code.to_s
59
+ p 'Message: ' + postResponse.message.to_s
60
+ p 'Results: ' + postResponse.results.to_json
61
+ p '-----------------------------'
62
+
63
+ raise 'Failure creating campaign' unless postResponse.success?
64
+
65
+ IDOfpostCampaign = postResponse.results['id']
66
+
67
+ # Retrieve the new Campaign
68
+ p '>>> Retrieve the new Campaign'
69
+ getCamp = FuelSDK::Campaign.new
70
+ getCamp.authStub = stubObj
71
+ getCamp.props = {"id" => IDOfpostCampaign}
72
+ getResponse = getCamp.get
73
+ p 'Retrieve Status: ' + getResponse.status.to_s
74
+ p 'Code: ' + getResponse.code.to_s
75
+ p 'Message: ' + getResponse.message.to_s
76
+ p 'Results: ' + getResponse.results.to_json
77
+ p '-----------------------------'
78
+
79
+ raise 'Failure retrieving campaign' unless getResponse.success?
80
+
81
+ # Update the new Campaign
82
+ p '>>> Update the new Campaign'
83
+ patchCamp = FuelSDK::Campaign.new
84
+ patchCamp.authStub = stubObj
85
+ patchCamp.props = {"id"=> IDOfpostCampaign, "name" => "RubySDKCreated-Updated!"}
86
+ patchResponse = patchCamp.patch
87
+ p 'Patch Status: ' + patchResponse.status.to_s
88
+ p 'Code: ' + patchResponse.code.to_s
89
+ p 'Message: ' + patchResponse.message.to_s
90
+ p 'Results: ' + patchResponse.results.to_json
91
+ p '-----------------------------'
92
+
93
+ raise 'Failure updating campaign' unless patchResponse.success?
94
+
95
+ # Retrieve the updated Campaign
96
+ p '>>> Retrieve the updated Campaign'
97
+ getCamp = FuelSDK::Campaign.new
98
+ getCamp.authStub = stubObj
99
+ getCamp.props = {"id" => IDOfpostCampaign}
100
+ getResponse = getCamp.get
101
+ p 'Retrieve Status: ' + getResponse.status.to_s
102
+ p 'Code: ' + getResponse.code.to_s
103
+ p 'Message: ' + getResponse.message.to_s
104
+ p 'Results: ' + getResponse.results.to_json
105
+ p '-----------------------------'
106
+
107
+ raise 'Failure retrieving campaign' unless getResponse.success?
108
+
109
+ # Create a new Campaign Asset
110
+ p '>>> Create a new Campaign Asset'
111
+ postCampAsset = FuelSDK::Campaign::Asset.new
112
+ postCampAsset.authStub = stubObj
113
+ postCampAsset.props = {"id" => IDOfpostCampaign, "ids"=> [ExampleAssetItemID], "type"=> ExampleAssetType}
114
+ postResponse = postCampAsset.post
115
+ p 'Post Status: ' + postResponse.status.to_s
116
+ p 'Code: ' + postResponse.code.to_s
117
+ p 'Message: ' + postResponse.message.to_s
118
+ p 'Results: ' + postResponse.results.to_json
119
+ p '-----------------------------'
120
+
121
+ raise 'Failure creating campaign assets' unless postResponse.success?
122
+
123
+ IDOfpostCampaignAsset = postResponse.results[0]['id']
124
+
125
+ # Retrieve all Campaign Asset for a campaign
126
+ p '>>> Retrieve all Campaign Asset for a Campaign'
127
+ getCampAsset = FuelSDK::Campaign::Asset.new
128
+ getCampAsset.authStub = stubObj
129
+ getCampAsset.props = {"id" => IDOfpostCampaign}
130
+ getResponse = getCampAsset.get
131
+ p 'Retrieve Status: ' + getResponse.status.to_s
132
+ p 'Code: ' + getResponse.code.to_s
133
+ p 'Message: ' + getResponse.message.to_s
134
+ p 'Results: ' + getResponse.results.inspect
135
+ p '-----------------------------'
136
+
137
+ raise 'Failure retrieving campaign assets' unless getResponse.success?
138
+
139
+ # Retrieve a single new Campaign Asset
140
+ p '>>> Retrieve a single new Campaign Asset'
141
+ getCampAsset = FuelSDK::Campaign::Asset.new
142
+ getCampAsset.authStub = stubObj
143
+ getCampAsset.props = {"id" => IDOfpostCampaign, "assetId" => IDOfpostCampaignAsset}
144
+ getResponse = getCampAsset.get
145
+ p 'Retrieve Status: ' + getResponse.status.to_s
146
+ p 'Code: ' + getResponse.code.to_s
147
+ p 'Message: ' + getResponse.message.to_s
148
+ p 'Results: ' + getResponse.results.inspect
149
+ p '-----------------------------'
150
+
151
+ raise 'Failure retrieving campaign asset' unless getResponse.success?
152
+
153
+ # Delete the new Campaign Asset
154
+ p '>>> Delete the new Campaign Asset'
155
+ deleteCampAsset = FuelSDK::Campaign::Asset.new
156
+ deleteCampAsset.authStub = stubObj
157
+ deleteCampAsset.props = {"id" => IDOfpostCampaign, "assetId"=> IDOfpostCampaignAsset}
158
+ deleteResponse = deleteCampAsset.delete
159
+ p 'Delete Status: ' + deleteResponse.status.to_s
160
+ p 'Code: ' + deleteResponse.code.to_s
161
+ p 'Message: ' + deleteResponse.message.to_s
162
+ p 'Results: ' + deleteResponse.results.to_json
163
+ p '-----------------------------'
164
+
165
+ raise 'Failure deleting campaign asset' unless deleteResponse.success?
166
+
167
+ # Get a single a new Campaign Asset to confirm deletion
168
+ p '>>> Get a single a new Campaign Asset to confirm deletion'
169
+ getCampAsset = FuelSDK::Campaign::Asset.new
170
+ getCampAsset.authStub = stubObj
171
+ getCampAsset.props = {"id" => IDOfpostCampaign}
172
+ getResponse = getCampAsset.get
173
+ p 'Retrieve Status: ' + getResponse.status.to_s
174
+ p 'Code: ' + getResponse.code.to_s
175
+ p 'Message: ' + getResponse.message.to_s
176
+ p 'Results: ' + getResponse.results.inspect
177
+ p '-----------------------------'
178
+
179
+ raise 'Failure retrieving campaign asset' unless getResponse.success?
180
+ raise 'Failure retrieving campaign asset' unless getResponse.results['totalCount'] == 0
181
+
182
+ rescue => e
183
+ p "Caught exception: #{e.message}"
184
+ p e.backtrace
185
+
186
+ ensure
187
+ # Delete the new Campaign
188
+ p '>>> Delete the new Campaign'
189
+ deleteCamp = FuelSDK::Campaign.new
190
+ deleteCamp.authStub = stubObj
191
+ deleteCamp.props = {"id"=> IDOfpostCampaign}
192
+ deleteResponse = deleteCamp.delete
193
+ p 'Delete Status: ' + deleteResponse.status.to_s
194
+ p 'Code: ' + deleteResponse.code.to_s
195
+ p 'Message: ' + deleteResponse.message.to_s
196
+ p 'Results: ' + deleteResponse.results.to_json
197
+ p '-----------------------------'
198
+
199
+ raise 'Failure deleting campaign asset' unless deleteResponse.success?
200
+
201
+ p '>>> Delete List'
202
+ deleteSub = FuelSDK::List.new()
203
+ deleteSub.authStub = stubObj
204
+ deleteSub.props = {"ID" => ExampleAssetItemID}
205
+ deleteResponse = deleteSub.delete
206
+ p 'Delete Status: ' + deleteResponse.status.to_s
207
+ p 'Code: ' + deleteResponse.code.to_s
208
+ p 'Message: ' + deleteResponse.message.to_s
209
+ p 'Results Length: ' + deleteResponse.results.length.to_s
210
+ p 'Results: ' + deleteResponse.results.to_s
211
+ end
@@ -0,0 +1,71 @@
1
+ require 'fuelsdk'
2
+ require_relative 'sample_helper'
3
+
4
+ begin
5
+ stubObj = FuelSDK::Client.new auth
6
+
7
+ ## Modify the date below to reduce the number of results returned from the request
8
+ ## Setting this too far in the past could result in a very large response size
9
+ retrieveDate = '2013-01-15T13:00:00.000'
10
+
11
+ p '>>> Retrieve Filtered ClickEvents with GetMoreResults'
12
+ getClickEvent = FuelSDK::ClickEvent.new()
13
+ getClickEvent.authStub = stubObj
14
+ getClickEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
15
+ getClickEvent.filter = {'Property' => 'EventDate','SimpleOperator' => 'greaterThan','DateValue' => retrieveDate}
16
+ getResponse = getClickEvent.get
17
+ p 'Retrieve Status: ' + getResponse.status.to_s
18
+ p 'Code: ' + getResponse.code.to_s
19
+ p 'Message: ' + getResponse.message.to_s
20
+ p 'MoreResults: ' + getResponse.more?.to_s
21
+ p 'RequestID: ' + getResponse.request_id.to_s
22
+ p 'Results Length: ' + getResponse.results.length.to_s
23
+ # Since this could potentially return a large number of results, we do not want to print the results
24
+ #p 'Results: ' + getResponse.results.to_s
25
+ #
26
+ raise 'Failure retrieving click events' unless getResponse.success?
27
+
28
+ while getResponse.more? do
29
+ p '>>> Continue Retrieve Filtered ClickEvents with GetMoreResults'
30
+ getResponse = getClickEvent.continue
31
+ p 'Retrieve Status: ' + getResponse.status.to_s
32
+ p 'Code: ' + getResponse.code.to_s
33
+ p 'Message: ' + getResponse.message.to_s
34
+ p 'MoreResults: ' + getResponse.more?.to_s
35
+ p 'RequestID: ' + getResponse.request_id.to_s
36
+ p 'Results Length: ' + getResponse.results.length.to_s
37
+ end
38
+
39
+ # The following request could potentially bring back large amounts of data if run against a production account
40
+ =begin
41
+ p '>>> Retrieve All ClickEvents with GetMoreResults'
42
+ getClickEvent = FuelSDK::ClickEvent.new()
43
+ getClickEvent.authStub = stubObj
44
+ getClickEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
45
+ getResponse = getClickEvent.get
46
+ p 'Retrieve Status: ' + getResponse.status.to_s
47
+ p 'Code: ' + getResponse.code.to_s
48
+ p 'Message: ' + getResponse.message.to_s
49
+ p 'MoreResults: ' + getResponse.more?.to_s
50
+ p 'RequestID: ' + getResponse.request_id.to_s
51
+ p 'Results Length: ' + getResponse.results.length.to_s
52
+ # Since this could potentially return a large number of results, we do not want to print the results
53
+ #p 'Results: ' + getResponse.results.to_s
54
+
55
+ while getResponse.more? do
56
+ p '>>> Continue Retrieve All ClickEvents with GetMoreResults'
57
+ getResponse = getClickEvent.continue
58
+ p 'Retrieve Status: ' + getResponse.status.to_s
59
+ p 'Code: ' + getResponse.code.to_s
60
+ p 'Message: ' + getResponse.message.to_s
61
+ p 'MoreResults: ' + getResponse.more?.to_s
62
+ p 'RequestID: ' + getResponse.request_id.to_s
63
+ p 'Results Length: ' + getResponse.results.length.to_s
64
+ end
65
+ =end
66
+
67
+ rescue => e
68
+ p "Caught exception: #{e.message}"
69
+ p e.backtrace
70
+ end
71
+
@@ -0,0 +1,122 @@
1
+ require 'fuelsdk'
2
+ require_relative 'sample_helper'
3
+
4
+ begin
5
+ stubObj = FuelSDK::Client.new auth
6
+
7
+ # Retrieve All ContentArea with GetMoreResults
8
+ p '>>> Retrieve All ContentArea with GetMoreResults'
9
+ getContent = FuelSDK::ContentArea.new()
10
+ getContent.authStub = stubObj
11
+ getContent.props = ["RowObjectID","ObjectID","ID","CustomerKey","Client.ID","ModifiedDate","CreatedDate","CategoryID","Name","Layout","IsDynamicContent","Content","IsSurvey","IsBlank","Key"]
12
+ getResponse = getContent.get
13
+ p 'Retrieve Status: ' + getResponse.status.to_s
14
+ p 'Code: ' + getResponse.code.to_s
15
+ p 'Message: ' + getResponse.message.to_s
16
+ p 'MoreResults: ' + getResponse.more?.to_s
17
+ p 'Results Length: ' + getResponse.results.length.to_s
18
+ #p 'Results: ' + getResponse.results.to_s
19
+ raise 'Failure retrieving contentarea' unless getResponse.success?
20
+
21
+ while getResponse.more? do
22
+ p '>>> Continue Retrieve All ContentArea with GetMoreResults'
23
+ getResponse = getContent.continue
24
+ p 'Retrieve Status: ' + getResponse.status.to_s
25
+ p 'Code: ' + getResponse.code.to_s
26
+ p 'Message: ' + getResponse.message.to_s
27
+ p 'MoreResults: ' + getResponse.more?.to_s
28
+ p 'RequestID: ' + getResponse.request_id.to_s
29
+ p 'Results Length: ' + getResponse.results.length.to_s
30
+ end
31
+
32
+ NameOfTestContentArea = "RubySDKContentArea"
33
+
34
+ # Create ContentArea
35
+ p '>>> Create ContentArea'
36
+ postContent = FuelSDK::ContentArea.new
37
+ postContent.authStub = stubObj
38
+ postContent.props = {"CustomerKey" => NameOfTestContentArea, "Name"=>NameOfTestContentArea, "Content"=> "<b>Some HTML Content Goes here</b>"}
39
+ postResponse = postContent.post
40
+ p 'Post Status: ' + postResponse.status.to_s
41
+ p 'Code: ' + postResponse.code.to_s
42
+ p 'Message: ' + postResponse.message.to_s
43
+ p 'Result Count: ' + postResponse.results.length.to_s
44
+ p 'Results: ' + postResponse.results.inspect
45
+ raise 'Failure creating contentarea' unless postResponse.success?
46
+
47
+ # Retrieve newly created ContentArea
48
+ p '>>> Retrieve newly created ContentArea'
49
+ getContent = FuelSDK::ContentArea.new()
50
+ getContent.authStub = stubObj
51
+ getContent.props = ["RowObjectID","ObjectID","ID","CustomerKey","Client.ID","ModifiedDate","CreatedDate","CategoryID","Name","Layout","IsDynamicContent","Content","IsSurvey","IsBlank","Key"]
52
+ getContent.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestContentArea}
53
+ getResponse = getContent.get
54
+ p 'Retrieve Status: ' + getResponse.status.to_s
55
+ p 'Code: ' + getResponse.code.to_s
56
+ p 'Message: ' + getResponse.message.to_s
57
+ p 'MoreResults: ' + getResponse.more?.to_s
58
+ p 'Results Length: ' + getResponse.results.length.to_s
59
+ p 'Results: ' + getResponse.results.to_s
60
+ raise 'Failure retrieving contentarea' unless getResponse.success?
61
+
62
+ # Update ContentArea
63
+ p '>>> Update ContentArea'
64
+ patchContent = FuelSDK::ContentArea.new
65
+ patchContent.authStub = stubObj
66
+ patchContent.props = {"CustomerKey" => NameOfTestContentArea, "Name"=>NameOfTestContentArea, "Content"=> "<b>Some HTML Content Goes here. NOW WITH NEW CONTENT</b>"}
67
+ patchResponse = patchContent.patch
68
+ p 'Patch Status: ' + patchResponse.status.to_s
69
+ p 'Code: ' + patchResponse.code.to_s
70
+ p 'Message: ' + patchResponse.message.to_s
71
+ p 'Result Count: ' + patchResponse.results.length.to_s
72
+ p 'Results: ' + patchResponse.results.inspect
73
+ raise 'Failure updating contentarea' unless patchResponse.success?
74
+
75
+ # Retrieve updated ContentArea
76
+ p '>>> Retrieve updated ContentArea'
77
+ getContent = FuelSDK::ContentArea.new()
78
+ getContent.authStub = stubObj
79
+ getContent.props = ["RowObjectID","ObjectID","ID","CustomerKey","Client.ID","ModifiedDate","CreatedDate","CategoryID","Name","Layout","IsDynamicContent","Content","IsSurvey","IsBlank","Key"]
80
+ getContent.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestContentArea}
81
+ getResponse = getContent.get
82
+ p 'Retrieve Status: ' + getResponse.status.to_s
83
+ p 'Code: ' + getResponse.code.to_s
84
+ p 'Message: ' + getResponse.message.to_s
85
+ p 'MoreResults: ' + getResponse.more?.to_s
86
+ p 'Results Length: ' + getResponse.results.length.to_s
87
+ p 'Results: ' + getResponse.results.to_s
88
+ raise 'Failure retrieving contentarea' unless getResponse.success?
89
+
90
+ # Delete ContentArea
91
+ p '>>> Delete ContentArea'
92
+ deleteContent = FuelSDK::ContentArea.new
93
+ deleteContent.authStub = stubObj
94
+ deleteContent.props = {"CustomerKey" => NameOfTestContentArea, "Name"=>NameOfTestContentArea, "Content"=> "<b>Some HTML Content Goes here. NOW WITH NEW CONTENT</b>"}
95
+ deleteResponse = deleteContent.delete
96
+ p 'Delete Status: ' + deleteResponse.status.to_s
97
+ p 'Code: ' + deleteResponse.code.to_s
98
+ p 'Message: ' + deleteResponse.message.to_s
99
+ p 'Result Count: ' + deleteResponse.results.length.to_s
100
+ p 'Results: ' + deleteResponse.results.inspect
101
+ raise 'Failure deleting contentarea' unless deleteResponse.success?
102
+
103
+ # Retrieve ContentArea to confirm deletion
104
+ p '>>> Retrieve ContentArea to confirm deletion'
105
+ getContent = FuelSDK::ContentArea.new()
106
+ getContent.authStub = stubObj
107
+ getContent.props = ["RowObjectID","ObjectID","ID","CustomerKey","Client.ID","ModifiedDate","CreatedDate","CategoryID","Name","Layout","IsDynamicContent","Content","IsSurvey","IsBlank","Key"]
108
+ getContent.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestContentArea}
109
+ getResponse = getContent.get
110
+ p 'Retrieve Status: ' + getResponse.status.to_s
111
+ p 'Code: ' + getResponse.code.to_s
112
+ p 'Message: ' + getResponse.message.to_s
113
+ p 'MoreResults: ' + getResponse.more?.to_s
114
+ p 'Results Length: ' + getResponse.results.length.to_s
115
+ p 'Results: ' + getResponse.results.to_s
116
+ raise 'Failure retrieving contentarea' unless getResponse.success?
117
+
118
+ rescue => e
119
+ p "Caught exception: #{e.message}"
120
+ p e.backtrace
121
+ end
122
+
@@ -0,0 +1,209 @@
1
+ require 'fuelsdk'
2
+ require_relative 'sample_helper'
3
+ require 'pry'
4
+
5
+ begin
6
+ stubObj = ET_Client.new auth
7
+
8
+ # Specify a name for the data extension that will be used for testing
9
+ # Note: Name and CustomerKey will be the same value
10
+ # WARNING: Data Extension will be deleted so don't use the name of a
11
+ # production data extension
12
+ NameOfDE = "ThisWillBeDeleted-Testz"
13
+
14
+ # Get all of the DataExtensions in an Account
15
+ p '>>> Get all of the DataExtensions in an Account'
16
+ de = ET_DataExtension.new
17
+ de.authStub = stubObj
18
+ de.props = ["CustomerKey", "Name"]
19
+ getResponse = de.get
20
+ p 'Retrieve Status: ' + getResponse.status.to_s
21
+ p 'Code: ' + getResponse.code.to_s
22
+ p 'Message: ' + getResponse.message.to_s
23
+ p 'MoreResults: ' + getResponse.more?.to_s
24
+ p 'RequestID: ' + getResponse.request_id.to_s
25
+ p 'Results Length: ' + getResponse.results.length.to_s
26
+ #p 'Results: ' + getResponse.results.to_s
27
+ raise 'Failure retrieving data extensions' unless getResponse.success?
28
+
29
+ # Create Data Extension
30
+ p '>>> Create Data Extension'
31
+ de2 = ET_DataExtension.new
32
+ de2.authStub = stubObj
33
+ de2.props = {"Name" => NameOfDE,"CustomerKey" => NameOfDE}
34
+ de2.columns = [{"Name" => "Name", "FieldType" => "Text", "IsPrimaryKey" => "true", "MaxLength" => "100", "IsRequired" => "true"},
35
+ {"Name" => "OtherField", "FieldType" => "Text"}]
36
+ postResponse = de2.post
37
+ p 'Post Status: ' + postResponse.status.to_s
38
+ p 'Code: ' + postResponse.code.to_s
39
+ p 'Message: ' + postResponse.message.to_s
40
+ p 'Results: ' + postResponse.results.inspect
41
+ raise 'Failure creating data extension' unless postResponse.success?
42
+
43
+ # Update DE to add new field
44
+ p '>>> Update DE to add new field'
45
+ de3 = ET_DataExtension.new
46
+ de3.authStub = stubObj
47
+ de3.props = {"Name" => NameOfDE,"CustomerKey" => NameOfDE}
48
+ de3.columns = [{"Name" => "AddedField", "FieldType" => "Text"}]
49
+ patchResponse = de3.patch
50
+ p 'Patch Status: ' + patchResponse.status.to_s
51
+ p 'Code: ' + patchResponse.code.to_s
52
+ p 'Message: ' + patchResponse.message.to_s
53
+ p 'Results: ' + patchResponse.results.inspect
54
+ raise 'Failure updating data extension' unless patchResponse.success?
55
+
56
+ # Retrieve all columns for data extension
57
+ p '>>> Retrieve all columns for data extension '
58
+ myDEColumn = ET_DataExtension::Column.new
59
+ myDEColumn.authStub = stubObj
60
+ myDEColumn.props = ["Name"]
61
+ myDEColumn.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfDE}
62
+ getResponse = myDEColumn.get
63
+ p 'Retrieve Status: ' + getResponse.status.to_s
64
+ p 'Code: ' + getResponse.code.to_s
65
+ p 'Message: ' + getResponse.message.to_s
66
+ p 'MoreResults: ' + getResponse.more?.to_s
67
+ p 'RequestID: ' + getResponse.request_id.to_s
68
+ p 'Results Length: ' + getResponse.results.length.to_s
69
+ p 'Results: ' + getResponse.results.to_s
70
+ raise 'Failure retrieving data extension columns' unless getResponse.success?
71
+ raise 'Failure retrieving correct number of data extension columns' unless getResponse.results.count == 3
72
+
73
+ # Add a row to a data extension (using CustomerKey)
74
+ p '>>> Add a row to a data extension'
75
+ de4 = ET_DataExtension::Row.new
76
+ de4.CustomerKey = NameOfDE;
77
+ de4.authStub = stubObj
78
+ de4.props = {"Name" => "MAC3", "OtherField" => "Text3"}
79
+ postResponse = de4.post
80
+ p 'Post Status: ' + postResponse.status.to_s
81
+ p 'Code: ' + postResponse.code.to_s
82
+ p 'Message: ' + postResponse.message.to_s
83
+ p 'Results: ' + postResponse.results.inspect
84
+ raise 'Failure creating data extension row' unless postResponse.success?
85
+
86
+ # Add a row to a data extension (Using Name)
87
+ p '>>> Add a row to a data extension'
88
+ de4 = ET_DataExtension::Row.new
89
+ de4.authStub = stubObj
90
+ de4.Name = NameOfDE
91
+ de4.props = {"Name" => "MAC4", "OtherField" => "Text3"}
92
+ postResponse = de4.post
93
+ p 'Post Status: ' + postResponse.status.to_s
94
+ p 'Code: ' + postResponse.code.to_s
95
+ p 'Message: ' + postResponse.message.to_s
96
+ p 'Results: ' + postResponse.results.inspect
97
+ raise 'Failure creating data extension row' unless postResponse.success?
98
+
99
+ # Retrieve all rows
100
+ p '>>> Retrieve all rows'
101
+ row = ET_DataExtension::Row.new()
102
+ row.authStub = stubObj
103
+ row.CustomerKey = NameOfDE
104
+ row.props = ["Name","OtherField"]
105
+ getResponse = row.get
106
+ p 'Retrieve Status: ' + getResponse.status.to_s
107
+ p 'Code: ' + getResponse.code.to_s
108
+ p 'Message: ' + getResponse.message.to_s
109
+ p 'MoreResults: ' + getResponse.more?.to_s
110
+ p 'RequestID: ' + getResponse.request_id.to_s
111
+ p 'Results Length: ' + getResponse.results.length.to_s
112
+ p 'Results: ' + getResponse.results.to_s
113
+ raise 'Failure retrieving data extension rows' unless getResponse.success?
114
+ raise 'Failure retrieving correct number of data extension rows' unless getResponse.results.count == 2
115
+
116
+ # Update a row in a data extension
117
+ p '>>> Update a row in a data extension'
118
+ de4 = ET_DataExtension::Row.new
119
+ de4.authStub = stubObj
120
+ de4.CustomerKey = NameOfDE
121
+ de4.props = {"Name" => "MAC3", "OtherField" => "UPDATED!"}
122
+ patchResponse = de4.patch
123
+ p 'Patch Status: ' + patchResponse.status.to_s
124
+ p 'Code: ' + patchResponse.code.to_s
125
+ p 'Message: ' + patchResponse.message.to_s
126
+ p 'Results: ' + patchResponse.results.inspect
127
+ raise 'Failure updating data extension row' unless patchResponse.success?
128
+
129
+ # Retrieve only updated row
130
+ p '>>> Retrieve only updated row'
131
+ row = ET_DataExtension::Row.new()
132
+ row.authStub = stubObj
133
+ row.CustomerKey = NameOfDE
134
+ row.props = ["Name","OtherField"]
135
+ row.filter = {'Property' => 'Name','SimpleOperator' => 'equals','Value' => 'MAC3'}
136
+ getResponse = row.get
137
+ p 'Retrieve Status: ' + getResponse.status.to_s
138
+ p 'Code: ' + getResponse.code.to_s
139
+ p 'Message: ' + getResponse.message.to_s
140
+ p 'MoreResults: ' + getResponse.more?.to_s
141
+ p 'RequestID: ' + getResponse.request_id.to_s
142
+ p 'Results Length: ' + getResponse.results.length.to_s
143
+ p 'Results: ' + getResponse.results.to_s
144
+ raise 'Failure retrieving data extension rows' unless getResponse.success?
145
+
146
+ # Delete a row from a data extension
147
+ p '>>> Delete a row from a data extension'
148
+ de4 = ET_DataExtension::Row.new
149
+ de4.authStub = stubObj
150
+ de4.CustomerKey = NameOfDE
151
+ de4.props = {"Name" => "MAC3"}
152
+ deleteResponse = de4.delete
153
+ p 'Delete Status: ' + deleteResponse.status.to_s
154
+ p 'Code: ' + deleteResponse.code.to_s
155
+ p 'Message: ' + deleteResponse.message.to_s
156
+ p 'Results: ' + deleteResponse.results.inspect
157
+ raise 'Failure deleting data extension row' unless deleteResponse.success?
158
+
159
+ # Delete a Data Extension
160
+ p '>>> Delete a Data Extension'
161
+ de5 = ET_DataExtension.new
162
+ de5.authStub = stubObj
163
+ de5.props = {"Name" => NameOfDE,"CustomerKey" => NameOfDE}
164
+ delResponse = de5.delete
165
+ p 'Post Status: ' + delResponse.status.to_s
166
+ p 'Code: ' + delResponse.code.to_s
167
+ p 'Message: ' + delResponse.message.to_s
168
+ p 'Results: ' + delResponse.results.inspect
169
+ raise 'Failure deleting data extension' unless deleteResponse.success?
170
+
171
+ =begin
172
+ # Retrieve lots of rows with more?
173
+ p '>>> Retrieve lots of rows with more?'
174
+ row = ET_DataExtension::Row.new()
175
+ row.authStub = stubObj
176
+ row.Name = "zipstolong"
177
+ row.props = ["zip","latitude","longitude"]
178
+ getResponse = row.get
179
+ p 'Retrieve Status: ' + getResponse.status.to_s
180
+ p 'Code: ' + getResponse.code.to_s
181
+ p 'Message: ' + getResponse.message.to_s
182
+ p 'MoreResults: ' + getResponse.more?.to_s
183
+ p 'RequestID: ' + getResponse.request_id.to_s
184
+ p 'Results Length: ' + getResponse.results.length.to_s
185
+ #p 'Results: ' + getResponse.results.to_s
186
+ raise 'Failure retrieving data extension rows' unless getResponse.success?
187
+
188
+ while getResponse.more? do
189
+ p '>>> Continue Retrieve lots of rows with more?'
190
+ getResponse = row.getMoreResults
191
+ p 'Retrieve Status: ' + getResponse.status.to_s
192
+ p 'Code: ' + getResponse.code.to_s
193
+ p 'Message: ' + getResponse.message.to_s
194
+ p 'MoreResults: ' + getResponse.more?.to_s
195
+ p 'RequestID: ' + getResponse.request_id.to_s
196
+ p 'Results Length: ' + getResponse.results.length.to_s
197
+ end
198
+ =end
199
+
200
+ rescue => e
201
+ p "Caught exception: #{e.message}"
202
+ p e.backtrace
203
+
204
+ de5 = ET_DataExtension.new
205
+ de5.authStub = stubObj
206
+ de5.props = {"Name" => NameOfDE,"CustomerKey" => NameOfDE}
207
+ de5.delete
208
+
209
+ end