telerivet 1.4.5 → 1.6.1

data/lib/telerivet/organization.rb

@@ -98,6 +98,86 @@ class Organization < Entity
         return @api.do_request("GET", get_base_api_path() + "/usage/#{usage_type}")
     end
 
+    #
+    # Retrieves statistics about messages sent or received via Telerivet. This endpoint returns
+    # historical data that is computed shortly after midnight each day in the project's time zone,
+    # and does not contain message statistics for the current day.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - start_date (string)
+    #         * Start date of message statistics, in YYYY-MM-DD format
+    #         * Required
+    #     
+    #     - end_date (string)
+    #         * End date of message statistics (inclusive), in YYYY-MM-DD format
+    #         * Required
+    #     
+    #     - rollup (string)
+    #         * Date interval to group by
+    #         * Allowed values: day, week, month, year, all
+    #         * Default: day
+    #     
+    #     - properties (string)
+    #         * Comma separated list of properties to group by
+    #         * Allowed values: org_id, org_name, org_industry, project_id, project_name, user_id,
+    #             user_email, user_name, phone_id, phone_name, phone_type, direction, source, status,
+    #             network_code, network_name, message_type, service_id, service_name, simulated, link
+    #     
+    #     - metrics (string)
+    #         * Comma separated list of metrics to return (summed for each distinct value of the
+    #             requested properties)
+    #         * Allowed values: count, num_parts, duration, price
+    #         * Required
+    #     
+    #     - currency (string)
+    #         * Three-letter ISO 4217 currency code used when returning the 'price' field. If the
+    #             original price was in a different currency, it will be converted to the requested
+    #             currency using the approximate current exchange rate.
+    #         * Default: USD
+    #     
+    #     - filters (Hash)
+    #         * Key-value pairs of properties and corresponding values; the returned statistics
+    #             will only include messages where the property matches the provided value. Only the
+    #             following properties are supported for filters: `user_id`, `phone_id`, `direction`,
+    #             `source`, `status`, `service_id`, `simulated`, `message_type`, `network_code`
+    #   
+    # Returns:
+    #     (associative array)
+    #       - intervals (array)
+    #           * List of objects representing each date interval containing at least one message
+    #               matching the filters.
+    #               Each object has the following properties:
+    #               
+    #               <table>
+    #               <tr><td> start_time </td> <td> The UNIX timestamp of the start
+    #               of the interval (int) </td></tr>
+    #               <tr><td> end_time </td> <td> The UNIX timestamp of the end of
+    #               the interval, exclusive (int) </td></tr>
+    #               <tr><td> start_date </td> <td> The date of the start of the
+    #               interval in YYYY-MM-DD format (string) </td></tr>
+    #               <tr><td> end_date </td> <td> The date of the end of the
+    #               interval in YYYY-MM-DD format, inclusive (string) </td></tr>
+    #               <tr><td> groups </td> <td> Array of groups for each
+    #               combination of requested property values matching the filters (array)
+    #               <br /><br />
+    #               Each object has the following properties:
+    #               <table>
+    #               <tr><td> properties </td> <td> An object of key/value
+    #               pairs for each distinct value of the requested properties (object) </td></tr>
+    #               <tr><td> metrics </td> <td> An object of key/value pairs
+    #               for each requested metric (object) </td></tr>
+    #               </table>
+    #               </td></tr>
+    #               </table>
+    #
+    def get_message_stats(options)
+        data = @api.do_request("GET", get_base_api_path() + "/message_stats", options)
+        return data
+    end
+
     #
     # Queries projects in this organization.
     # 

data/lib/telerivet/phone.rb

@@ -115,7 +115,8 @@ class Phone < Entity
     #     
     #     - source
     #         * Filter messages by source
-    #         * Allowed values: phone, provider, web, api, service, webhook, scheduled
+    #         * Allowed values: phone, provider, web, api, service, webhook, scheduled,
+    #             integration
     #     
     #     - starred (bool)
     #         * Filter messages by starred/unstarred
@@ -123,7 +124,7 @@ class Phone < Entity
     #     - status
     #         * Filter messages by status
     #         * Allowed values: ignored, processing, received, sent, queued, failed,
-    #             failed_queued, cancelled, delivered, not_delivered
+    #             failed_queued, cancelled, delivered, not_delivered, read
     #     
     #     - time_created[min] (UNIX timestamp)
     #         * Filter messages created on or after a particular time
@@ -133,18 +134,26 @@ class Phone < Entity
     #     
     #     - external_id
     #         * Filter messages by ID from an external provider
+    #         * Allowed modifiers: external_id[ne], external_id[exists]
     #     
     #     - contact_id
     #         * ID of the contact who sent/received the message
+    #         * Allowed modifiers: contact_id[ne], contact_id[exists]
     #     
     #     - phone_id
     #         * ID of the phone (basic route) that sent/received the message
     #     
     #     - broadcast_id
     #         * ID of the broadcast containing the message
+    #         * Allowed modifiers: broadcast_id[ne], broadcast_id[exists]
     #     
     #     - scheduled_id
     #         * ID of the scheduled message that created this message
+    #         * Allowed modifiers: scheduled_id[ne], scheduled_id[exists]
+    #     
+    #     - group_id
+    #         * Filter messages sent or received by contacts in a particular group. The group must
+    #             be a normal group, not a dynamic group.
     #     
     #     - sort
     #         * Sort the results based on a field