callrail 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbbaf506ead787ca52dc63840bb542d453d49a34
-  data.tar.gz: c612a2e8c8fb78bf487947a8a13736bd5bb407df
+  metadata.gz: 711be4fe1640adfe3c857a8b4014467fa17d1200
+  data.tar.gz: 0acb033d592e81ce66985dd42476d066822d92c2
 SHA512:
-  metadata.gz: 81cad40eb9c1b41226ecfa9d89779a76ff9866ffbd41e4537b07f372b1d62187dd927122178f5ac6bce60f9341bc89a6451cbec46f83b13a9ff08ef67cfde441
-  data.tar.gz: 962ea32852ee2427319273b5a8b01de3aa7a905c039b34b61aa455ade32fa676df8a4a7be2fd0a0437e5072f3628ac48cd156c93573a5bb7985bc5dc377bd7ae
+  metadata.gz: 1d59d1537dbfe8d723c09a69fccf7fa081749a023b3afe10162b54db789d0c122d4da07778d2c9df1e4e5eeb82ffc2b6e1753a379e0666802e7b4ddd71337f59
+  data.tar.gz: 727f635520ccb319e942ecabff2eb9208d2a29bb84bbc1644f01a1f3e5dc2b040543597a4755d324187c1573181d4a3fcc5a8653422c4d6833ff7385a1729db4

data/README.md

@@ -21,6 +21,11 @@ Or install it yourself as:
     $ gem install callrail
 
 ## Usage
+###### Time options
+Callrail defaults to last_30_days if a date range isn't specified.
+opts[:date_range] - Values: recent, today, yesterday, last_7_days, last_30_days, this_month, last_month, all_time
+opts[:start_date] - ex: “2015-09-05” for all calls after and including September 9, 2015 - “2015-09-05T10:00” for all calls after 10 AM September 5, 2015
+opts[:end_date] - ex: “2015-10-05” for all calls before and including October 9, 2
 
 * *Examples of what is currently enabled
 
@@ -167,6 +172,46 @@ tracker_options[:source] = {:type => "search", :search_engine => "all", :search_
 tracker_options[:tracker_id] = <tracker_id>
 puts testcon.update_tracker(tracker_options)
 
+###### Get Calls   
+Sorting: customer_name, customer_phone_number, duration, start_time, source
+Filtering: date_range, answer_status, device, direction, lead_status
+Searching: caller_name, note, source, dialed_number, caller_number, outgoing_number
+        
+```
+call_options = {}
+testcon.get_calls(call_options)
+```
+
+###### Get a specific call
+```
+call_options = {call_id: <call_id>}
+testcon.get_calls(call_options)
+```
+
+###### Update a specific call
+```
+call_options = {call_id: <call_id>}
+call_options[:note] = "Test"
+testcon.update_call(call_options)
+```
+###### Get Calls summary
+Summary Grouping: source, keywords, campaign, referrer, landing_page, or company
+Summary Fields: total_calls, missed_calls, answered_calls, first_time_callers, average_duration, formatted_average_duration, leads. Defaults to total_calls
+```
+summary_options = {group_by: "campaign"}
+testcon.get_calls_summary(summary_options)
+```
+
+For a time series (grouped by date), set  summary_options[:time_series] = true
+
+
+###### Getting Call recording URL
+```
+call_options = {}
+call_options[:call_id] = >call_id>
+puts testcon.get_call_recording(call_options)
+```
+
 ###### Getting Integrations for a company
 ```
 int_opts = {}

data/lib/callrail.rb

@@ -91,12 +91,26 @@ module Callrail
         params[:tracking_number] = opts[:tracking_number] if opts[:tracking_number]
       #Integration Params
         params[:config] = opts[:config] if opts[:config] 
-        params[:state] = opts[:state] if opts[:state]
-
+        params[:state] = opts[:state] if opts[:state] 
       #Call Params
         # Sorting: customer_name, customer_phone_number, duration, start_time, source
         # Filtering: date_range, answer_status, device, direction, lead_status
         # Searching: caller_name, note, source, dialed_number, caller_number, outgoing_number
+        # Summary Grouping: source, keywords, campaign, referrer, landing_page, or company
+        # Summary Fields: total_calls, missed_calls, answered_calls, first_time_callers, average_duration, formatted_average_duration, leads. Defaults to total_calls
+        params[:tags] = opts[:tags] if opts[:tags]
+        params[:note] = opts[:note] if opts[:note]
+        params[:value] = opts[:value] if opts[:value]
+        params[:lead_status] = opts[:lead_status] if opts[:lead_status]
+        params[:group_by] = opts[:group_by] if opts[:group_by]
+        params[:device] = opts[:device] if opts[:device]
+        params[:min_duration] = opts[:min_duration] if opts[:min_duration]
+        params[:max_duration] = opts[:max_duration] if opts[:max_duration]
+        params[:tracker_ids] = opts[:tracker_ids] if opts[:tracker_ids]
+        params[:direction] = opts[:direction] if opts[:direction]
+        params[:answer_status] = opts[:answer_status] if opts[:answer_status]
+        params[:first_time_callers] = opts[:first_time_callers] if opts[:first_time_callers]
+        params[:agent] = opts[:agent] if opts[:agent]
       #Text Message Params
         # Filtering: date_range
         # Searching: customer_phone_number, customer_name
@@ -122,14 +136,14 @@ module Callrail
       return responses.flatten! || responses
     end
 
-# Account Calls
+# Account 
     def get_accounts(opts = {})
       opts[:path] = (opts[:account_id]) ? "/" + opts[:account_id].to_s + ".json" : ".json"
       opts[:data] = "accounts" unless  opts[:account_id]
       return get_responses(opts)  
     end
 
-# Company Calls
+# Company 
     def get_companies(opts = {}) 
       opts[:path] = (opts[:company_id]) ? "/" + @account_id + "/companies/" + opts[:company_id].to_s + ".json" : "/" + @account_id + "/companies.json"
       opts[:data] = "companies" unless opts[:company_id]
@@ -154,7 +168,7 @@ module Callrail
       return parse_json(RestClient.delete(@url+path, :Authorization => @auth))
     end
 
-# User Calls
+# User 
     def get_users( opts={} )
       opts[:path] = (opts[:user_id]) ? "/" + @account_id + "/users/" + opts[:user_id].to_s + ".json" : "/" + @account_id + "/users.json"
       opts[:data] = "users" unless opts[:user_id]
@@ -173,7 +187,33 @@ module Callrail
       return parse_json(RestClient.put(@url+path, params, :Authorization => @auth))      
     end
 
-# Tracker Calls    
+# Calls
+    def get_calls( opts={} )
+      opts[:path] = (opts[:call_id]) ? "/" + @account_id + "/calls/" + opts[:call_id].to_s + ".json" : "/" + @account_id + "/calls.json" 
+      opts[:data] = "calls"  unless opts[:call_id]
+      return get_responses(opts)
+    end
+
+    def get_calls_summary( opts={} )
+      opts[:path] =  (opts[:time_series] == true) ? "/" + @account_id + "/calls/timeseries.json" : "/" + @account_id + "/calls/summary.json" 
+      return get_responses(opts)
+    end
+
+    def update_call(opts = {})
+      params = set_params(opts) 
+      path =  "/" + @account_id + "/calls/" + opts[:call_id].to_s + ".json"
+      return parse_json(RestClient.put(@url+path, params, :Authorization => @auth))      
+    end
+
+    def get_call_recording( opts={} )
+      opts[:path] =  "/" + @account_id + "/calls/" + opts[:call_id].to_s + "/recording.json"
+      opts[:data] = "url"
+      return get_responses(opts).first
+    end
+
+    
+
+# Tracker     
     def get_trackers(opts={})
       opts[:path] = (opts[:tracker_id]) ? "/" + @account_id + "/trackers/" + opts[:tracker_id].to_s + ".json" : "/" + @account_id + "/trackers.json"
       opts[:data] = "trackers" unless opts[:tracker_id]

data/lib/callrail/version.rb

@@ -1,3 +1,3 @@
 module Callrail
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callrail
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Michael Hoskison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler