telerivet 1.1.4 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be1f221262cc98190c641723d908f68310443816
-  data.tar.gz: a6226f0040d537a9d57e8cb0ba5096cd146d86b1
+  metadata.gz: 069e4d71945ecfebc99b45656fdf47b36fd35e19
+  data.tar.gz: d5bd1f041f21e6e7b14fd48852cbf8f8d3fecafb
 SHA512:
-  metadata.gz: d4305ddcd83b4eb883be1cc34a182034e34911e7bf511532c28db91f728b5341d974b722d4b679de2954583e4f22b760745b01c9ec4e7e9be707bc8fb12ce4b8
-  data.tar.gz: d4fa2bd64725feb1459cbfa018a0755154e5dd8a9cf79cf75244248b254a566a6d71fccc71004e6ce3e9471c79fad55063ddd9f6cbdc93d5a21b16b11d08d73e
+  metadata.gz: 2e6b9787dc8fdddbad0ef1b1c35f52bbbefb25c245f8588b49801606f90664b99f52c552a581a46b6bc5f83b5b31477be66f8aa1482002250fca5ffe6091c51d
+  data.tar.gz: 53288dabcb2af64d9e5341e1c1e495f9f676aa1f7decf595e0bdc28a32804408ab2a13fb6a6813cd7d6d8a518d25327af55401431104d73248c157fd0174dad2

data/lib/telerivet.rb

@@ -8,7 +8,7 @@ module Telerivet
 class API    
     attr_reader :num_requests
 
-    @@client_version = '1.1.4'
+    @@client_version = '1.1.6'
     
     #
     # Initializes a client handle to the Telerivet REST API.

data/lib/telerivet/contact.rb

@@ -19,14 +19,38 @@ module Telerivet
 #       * Time the contact was added in Telerivet
 #       * Read-only
 #   
+#   - send_blocked (bool)
+#       * True if Telerivet is blocked from sending messages to this contact
+#       * Updatable via API
+#   
 #   - last_message_time (UNIX timestamp)
 #       * Last time the contact sent or received a message (null if no messages have been sent
 #           or received)
 #       * Read-only
 #   
+#   - last_incoming_message_time (UNIX timestamp)
+#       * Last time a message was received from this contact
+#       * Read-only
+#   
+#   - last_outgoing_message_time (UNIX timestamp)
+#       * Last time a message was sent to this contact
+#       * Read-only
+#   
+#   - message_count (int)
+#       * Total number of non-deleted messages sent to or received from this contact
+#       * Read-only
+#   
+#   - incoming_message_count (int)
+#       * Number of messages received from this contact
+#       * Read-only
+#   
+#   - outgoing_message_count (int)
+#       * Number of messages sent to this contact
+#       * Read-only
+#   
 #   - last_message_id
-#       * ID of the last message sent or received by this contact (null if no messages have
-#           been sent or received)
+#       * ID of the last message sent to or received from this contact (null if no messages
+#           have been sent or received)
 #       * Read-only
 #   
 #   - default_route_id
@@ -164,6 +188,9 @@ class Contact < Entity
     #         * Allowed modifiers: name[ne], name[prefix], name[not_prefix], name[gte], name[gt],
     #             name[lt], name[lte]
     #     
+    #     - dynamic (bool)
+    #         * Filter groups by dynamic/non-dynamic
+    #     
     #     - sort
     #         * Sort the results based on a field
     #         * Allowed values: default, name
@@ -246,12 +273,6 @@ class Contact < Entity
     #         * Filter data rows by the time they were created
     #         * Allowed modifiers: time_created[ne], time_created[min], time_created[max]
     #     
-    #     - vars (Hash)
-    #         * Filter data rows by value of a custom variable (e.g. vars[q1], vars[foo], etc.)
-    #         * Allowed modifiers: vars[foo][exists], vars[foo][ne], vars[foo][prefix],
-    #             vars[foo][not_prefix], vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte],
-    #             vars[foo][min], vars[foo][max]
-    #     
     #     - sort
     #         * Sort the results based on a field
     #         * Allowed values: default
@@ -359,10 +380,38 @@ class Contact < Entity
         get('time_created')
     end
 
+    def send_blocked
+        get('send_blocked')
+    end
+
+    def send_blocked=(value)
+        set('send_blocked', value)
+    end
+
     def last_message_time
         get('last_message_time')
     end
 
+    def last_incoming_message_time
+        get('last_incoming_message_time')
+    end
+
+    def last_outgoing_message_time
+        get('last_outgoing_message_time')
+    end
+
+    def message_count
+        get('message_count')
+    end
+
+    def incoming_message_count
+        get('incoming_message_count')
+    end
+
+    def outgoing_message_count
+        get('outgoing_message_count')
+    end
+
     def last_message_id
         get('last_message_id')
     end

data/lib/telerivet/group.rb

@@ -14,8 +14,12 @@ module Telerivet
 #       * Name of the group
 #       * Updatable via API
 #   
+#   - dynamic (bool)
+#       * Whether this is a dynamic or normal group
+#       * Read-only
+#   
 #   - num_members (int)
-#       * Number of contacts in the group
+#       * Number of contacts in the group (null if the group is dynamic)
 #       * Read-only
 #   
 #   - time_created (UNIX timestamp)
@@ -57,6 +61,31 @@ class Group < Entity
     #         * Allowed modifiers: last_message_time[exists], last_message_time[ne],
     #             last_message_time[min], last_message_time[max]
     #     
+    #     - last_incoming_message_time (UNIX timestamp)
+    #         * Filter contacts by last time a message was received
+    #         * Allowed modifiers: last_incoming_message_time[exists],
+    #             last_incoming_message_time[ne], last_incoming_message_time[min],
+    #             last_incoming_message_time[max]
+    #     
+    #     - last_outgoing_message_time (UNIX timestamp)
+    #         * Filter contacts by last time a message was sent
+    #         * Allowed modifiers: last_outgoing_message_time[exists],
+    #             last_outgoing_message_time[ne], last_outgoing_message_time[min],
+    #             last_outgoing_message_time[max]
+    #     
+    #     - incoming_message_count (int)
+    #         * Filter contacts by number of messages received from the contact
+    #         * Allowed modifiers: incoming_message_count[ne], incoming_message_count[min],
+    #             incoming_message_count[max]
+    #     
+    #     - outgoing_message_count (int)
+    #         * Filter contacts by number of messages sent to the contact
+    #         * Allowed modifiers: outgoing_message_count[ne], outgoing_message_count[min],
+    #             outgoing_message_count[max]
+    #     
+    #     - send_blocked (bool)
+    #         * Filter contacts by blocked status
+    #     
     #     - vars (Hash)
     #         * Filter contacts by value of a custom variable (e.g. vars[email], vars[foo], etc.)
     #         * Allowed modifiers: vars[foo][exists], vars[foo][ne], vars[foo][prefix],
@@ -160,6 +189,10 @@ class Group < Entity
         set('name', value)
     end
 
+    def dynamic
+        get('dynamic')
+    end
+
     def num_members
         get('num_members')
     end

data/lib/telerivet/message.rb

@@ -89,6 +89,15 @@ module Telerivet
 #       * The currency of the message price, if applicable.
 #       * Read-only
 #   
+#   - duration (number)
+#       * The duration of the call in seconds, if known, or -1 if the call was not answered.
+#       * Read-only
+#   
+#   - ring_time (number)
+#       * The length of time the call rang in seconds before being answered or hung up, if
+#           known.
+#       * Read-only
+#   
 #   - mms_parts (array)
 #       * A list of parts in the MMS message, the same as returned by the
 #           [getMMSParts](#Message.getMMSParts) method.
@@ -110,6 +119,10 @@ module Telerivet
 #       * ID of the route that sent the message (if applicable)
 #       * Read-only
 #   
+#   - user_id (string, max 34 characters)
+#       * ID of the Telerivet user who sent the message (if applicable)
+#       * Read-only
+#   
 #   - project_id
 #       * ID of the project this contact belongs to
 #       * Read-only
@@ -301,6 +314,14 @@ class Message < Entity
         get('price_currency')
     end
 
+    def duration
+        get('duration')
+    end
+
+    def ring_time
+        get('ring_time')
+    end
+
     def mms_parts
         get('mms_parts')
     end
@@ -317,6 +338,10 @@ class Message < Entity
         get('route_id')
     end
 
+    def user_id
+        get('user_id')
+    end
+
     def project_id
         get('project_id')
     end

data/lib/telerivet/phone.rb

@@ -57,6 +57,11 @@ module Telerivet
 #           the last time it connected to Telerivet (only present for Android phones)
 #       * Read-only
 #   
+#   - internet_type
+#       * String describing the current type of internet connectivity for an Android phone,
+#           for example WIFI or MOBILE (only present for Android phones)
+#       * Read-only
+#   
 #   - app_version
 #       * Currently installed version of Telerivet Android app (only present for Android
 #           phones)
@@ -217,6 +222,10 @@ class Phone < Entity
         get('charging')
     end
 
+    def internet_type
+        get('internet_type')
+    end
+
     def app_version
         get('app_version')
     end

data/lib/telerivet/project.rb

@@ -114,12 +114,12 @@ class Project < Entity
     #     - status_url
     #         * Webhook callback URL to be notified when message status changes
     #     
-    #     - label_ids (array)
-    #         * Array of IDs of labels to add to all messages sent (maximum 5)
-    #     
     #     - status_secret
     #         * POST parameter 'secret' passed to status_url
     #     
+    #     - label_ids (array)
+    #         * Array of IDs of labels to add to all messages sent (maximum 5)
+    #     
     #     - exclude_contact_id
     #         * Optionally excludes one contact from receiving the message (only when group_id is
     #             set)
@@ -264,29 +264,48 @@ class Project < Entity
     #
     # Retrieves OR creates and possibly updates a contact by name or phone number.
     # 
-    # If a phone number is provided, Telerivet will search for an existing
-    # contact with that phone number (including suffix matches to allow finding contacts with
-    # phone numbers in a different format).
-    # 
-    # If a phone number is not provided but a name is provided, Telerivet
-    # will search for a contact with that exact name (case insensitive).
+    # If a phone number is provided, by default, Telerivet will search for
+    # an existing contact with that phone number (including suffix matches to allow finding
+    # contacts with phone numbers in a different format). If a phone number is not provided but a
+    # name is provided, Telerivet will search for a contact with that exact name (case
+    # insensitive). This behavior can be modified by setting the lookup_key parameter to look up a
+    # contact by another field, including a custom variable.
     # 
     # If no existing contact is found, a new contact will be created.
     # 
     # Then that contact will be updated with any parameters provided
-    # (name, phone_number, and vars).
+    # (name, phone_number, vars, default\_route\_id, send\_blocked, add\_group\_ids,
+    # remove\_group\_ids).
     # 
     # Arguments:
     #   - options (Hash)
-    #       * Required
     #     
     #     - name
     #         * Name of the contact
-    #         * Required if phone_number not set
     #     
     #     - phone_number
     #         * Phone number of the contact
-    #         * Required if name not set
+    #     
+    #     - lookup_key
+    #         * The field used to search for a matching contact, or 'none' to always create a new
+    #             contact. To search by a custom variable, precede the variable name with 'vars.'.
+    #         * Allowed values: phone_number, name, id, vars.variable_name, none
+    #         * Default: phone_number
+    #     
+    #     - send_blocked (bool)
+    #         * True if Telerivet is blocked from sending messages to this contact
+    #     
+    #     - default_route_id
+    #         * ID of the route to use by default to send messages to this contact
+    #     
+    #     - add_group_ids (array)
+    #         * ID of one or more groups to add this contact as a member (max 20)
+    #     
+    #     - id
+    #         * ID of an existing contact (only used if lookup_key is 'id')
+    #     
+    #     - remove_group_ids (array)
+    #         * ID of one or more groups to remove this contact as a member (max 20)
     #     
     #     - vars (Hash)
     #         * Custom variables and values to update on the contact
@@ -294,7 +313,7 @@ class Project < Entity
     # Returns:
     #     Telerivet::Contact
     #
-    def get_or_create_contact(options)
+    def get_or_create_contact(options = nil)
         require_relative 'contact'
         Contact.new(@api, @api.do_request("POST", get_base_api_path() + "/contacts", options))
     end
@@ -325,6 +344,31 @@ class Project < Entity
     #         * Allowed modifiers: last_message_time[exists], last_message_time[ne],
     #             last_message_time[min], last_message_time[max]
     #     
+    #     - last_incoming_message_time (UNIX timestamp)
+    #         * Filter contacts by last time a message was received
+    #         * Allowed modifiers: last_incoming_message_time[exists],
+    #             last_incoming_message_time[ne], last_incoming_message_time[min],
+    #             last_incoming_message_time[max]
+    #     
+    #     - last_outgoing_message_time (UNIX timestamp)
+    #         * Filter contacts by last time a message was sent
+    #         * Allowed modifiers: last_outgoing_message_time[exists],
+    #             last_outgoing_message_time[ne], last_outgoing_message_time[min],
+    #             last_outgoing_message_time[max]
+    #     
+    #     - incoming_message_count (int)
+    #         * Filter contacts by number of messages received from the contact
+    #         * Allowed modifiers: incoming_message_count[ne], incoming_message_count[min],
+    #             incoming_message_count[max]
+    #     
+    #     - outgoing_message_count (int)
+    #         * Filter contacts by number of messages sent to the contact
+    #         * Allowed modifiers: outgoing_message_count[ne], outgoing_message_count[min],
+    #             outgoing_message_count[max]
+    #     
+    #     - send_blocked (bool)
+    #         * Filter contacts by blocked status
+    #     
     #     - vars (Hash)
     #         * Filter contacts by value of a custom variable (e.g. vars[email], vars[foo], etc.)
     #         * Allowed modifiers: vars[foo][exists], vars[foo][ne], vars[foo][prefix],
@@ -576,6 +620,9 @@ class Project < Entity
     #         * Allowed modifiers: name[ne], name[prefix], name[not_prefix], name[gte], name[gt],
     #             name[lt], name[lte]
     #     
+    #     - dynamic (bool)
+    #         * Filter groups by dynamic/non-dynamic
+    #     
     #     - sort
     #         * Sort the results based on a field
     #         * Allowed values: default, name
@@ -913,7 +960,7 @@ class Project < Entity
     #     
     #     - context
     #         * Filter services that can be invoked in a particular context
-    #         * Allowed values: message, contact, project, receipt
+    #         * Allowed values: message, contact, project
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -1129,6 +1176,18 @@ class Project < Entity
         return Route.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
 
+    #
+    # Returns an array of user accounts that have access to this project. Each item in the array
+    # is an object containing `id`, `email`, and `name` properties. (The id corresponds to the
+    # `user_id` property of the Message object.)
+    # 
+    # Returns:
+    #     array
+    #
+    def get_users()
+        return @api.do_request("GET", get_base_api_path() + "/users")
+    end
+
     #
     # Saves any fields or custom variables that have changed for the project.
     #

data/lib/telerivet/service.rb

@@ -94,7 +94,7 @@ class Service < Entity
     #     
     #     - context
     #         * The name of the context in which this service is invoked
-    #         * Allowed values: message, contact, project, receipt
+    #         * Allowed values: message, contact, project
     #         * Required
     #     
     #     - event

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerivet
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.6
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-09-20 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com
@@ -16,8 +16,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/telerivet.rb
 - lib/cacert.pem
+- lib/telerivet.rb
 - lib/telerivet/apicursor.rb
 - lib/telerivet/contact.rb
 - lib/telerivet/contactservicestate.rb
@@ -43,17 +43,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Telerivet REST API Client