Merge pull request #73 from sendwithus/remove-unused-methods

Remove unused methods and tidy up README

Author: demoore

CHANGELOG.md

@@ -1,3 +1,4 @@
+4.0.1 - Remove unused methods
 4.0.0 - Deprecate Logs List API endpoint
 3.1.0 - Add `strict` option to the render call
 3.0.0 - Deprecate and remove Conversions API calls

README.md

@@ -150,7 +150,7 @@ begin
         ],
         files: ['path/to/attachment.txt'],
         esp_account: 'esp_MYESPACCOUNT',
-        version: 'v2',
+        version_name: 'v2',
         tags: ['tag1', 'tag2'],
         locale: 'en-US')
     puts result
@@ -214,6 +214,7 @@ end
 ```
 
 ### Remove Customer from Drip Campaign
+
 ```ruby
 require 'rubygems'
 require 'send_with_us'
@@ -285,23 +286,9 @@ result = obj.customer_create("visha@example.com")
 result = obj.customer_delete("visha@example.com")
 ```
 
-### Get logs for customer
-This will retrieve email logs for a customer.
-
-Optional Arguments:
-- **count** – The number of logs to return. _Max: 100, Default: 100._
-- **created_gt** – Return logs created strictly after the given UTC timestamp.
-- **created_lt** – Return logs created strictly before the given UTC timestamp.
-
-
-```ruby
-obj.customer_email_log('customer@example.com', count: 1)
-```
-
 ## Templates
 
 ```ruby
-
 # List Templates
 obj.list_templates() # Alternatively, obj.emails()
 
@@ -314,12 +301,14 @@ obj.delete_template(template_id)
 # List Template Versions
 obj.list_template_versions(template_id)
 
+# Get Template Version
+obj.get_template_version(template_id, version_id)
+
 # Update Template Version
 obj.update_template_version(template_id, version_id, name, subject, html, text)
 
 # Create Template Version
 obj.create_template_version(template_id, name, subject, html, text)
-
 ```
 
 
@@ -353,16 +342,24 @@ Take a look at our Mailer that you can use similarly to ActionMailer
 
 ## Logs
 
+### Get single log
+
+Used to get the details for a single log. The log ID can be obtained by recording the `receipt_id` value returned from the `send` call.
+
+```ruby
+obj.log('log_sld7xWJ3isc23-3')
+```
+
+### Get logs for customer
+This will retrieve email logs for a customer.
+
 Optional Arguments:
 - **count** – The number of logs to return. _Max: 100, Default: 100._
-- **offset** – Offset the number of logs to return. _Default: 0_
 - **created_gt** – Return logs created strictly after the given UTC timestamp.
-- **created_gte** – Return logs created on or after the given UTC timestamp.
 - **created_lt** – Return logs created strictly before the given UTC timestamp.
-- **created_lte** – Return logs created on or before the given UTC timestamp.
 
 ```ruby
-obj.logs(count: 1, offset: 1)
+obj.customer_email_log('customer@example.com', count: 1)
 ```
 
 ## Errors

lib/send_with_us/api.rb

@@ -214,14 +214,6 @@ def drip_campaign_details(drip_campaign_id)
       SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}")
     end
 
-    def list_customers_on_campaign(drip_campaign_id)
-      SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}/customers")
-    end
-
-    def list_customers_on_campaign_step(drip_campaign_id, drip_campaign_step_id)
-      SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}/step/#{drip_campaign_step_id}/customers")
-    end
-
     def customer_get(email)
       SendWithUs::ApiRequest.new(@configuration).get("customers/#{email}")
     end

lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '3.1.0'
+  VERSION = '4.0.1'
 end