telerivet 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 303a6df0ce9d23233621cac3732ab09afb1b9bf968d784441e29bd343a4ec105
-  data.tar.gz: fad6a45b9e7b0cd84668f49a129a6600b3fcd4898b18d193d476deede36c9323
+  metadata.gz: 2276ff47e23f0670121a7295c0cf3d860740ebb0c1980de13e15ae2f25c2659d
+  data.tar.gz: 55db2507c8bcfa9f8ed0c3102f830dea689fd57ef57d0a00f1b488eebf46f4b5
 SHA512:
-  metadata.gz: 4b030343b0e5d79d4c1d520d348baccfe77a7d171fab5b86f1f3a0b16e914f82ad3c5eab796fd2ddcec3480a1f952e030208f5db2eaaa568b3eb079fddbaa1ca
-  data.tar.gz: a8c12e9cfbb08f568f40cb4647646d033aa55d1864b1acd28219ff27d587d04ef2bff994b8aa0ab43c3082446de03bebe2ad90a99ba25a22ea40700505954e68
+  metadata.gz: cdd68937b393e61a1ec76e536b0abfcf30e3bb16127b2ea6a37f221013c8ee9d43aa99f5bf758eeb70d04c0366ffcfe1a2e4af576d0620507412b92ac8ceeab7
+  data.tar.gz: 50cf5362c2926a104d8e1d6cd15ee5473589cdf31e78e516f9e6ad1af335baec040de5b5cf8598dc8e95008e08fe9775a448da465fffc708030b8e217d86e52a

data/lib/telerivet/airtimetransaction.rb

@@ -28,6 +28,14 @@ module Telerivet
 #       * Country code
 #       * Read-only
 #   
+#   - time_created (UNIX timestamp)
+#       * The time that the airtime transaction was created on Telerivet's servers
+#       * Read-only
+#   
+#   - transaction_time (UNIX timestamp)
+#       * The time that the airtime transaction was sent, or null if it has not been sent
+#       * Read-only
+#   
 #   - status
 #       * Current status of airtime transaction (`successful`, `failed`, `cancelled`,
 #           `queued`, `pending_approval`, or `pending_payment`)
@@ -90,6 +98,14 @@ class AirtimeTransaction < Entity
         get('country')
     end
 
+    def time_created
+        get('time_created')
+    end
+
+    def transaction_time
+        get('transaction_time')
+    end
+
     def status
         get('status')
     end

data/lib/telerivet/apicursor.rb

@@ -13,16 +13,16 @@ class APICursor
 
     def initialize(api, item_cls, path, params = nil)
         params ||= {}
-    
+
         if params.has_key?('count')
             raise Exception, "Cannot construct APICursor with 'count' parameter. Call the count() method instead."
         end
-    
+
         @api = api
         @item_cls = item_cls
         @path = path
         @params = params
-        
+
         @count = -1
         @pos = nil
         @data = nil
@@ -31,15 +31,15 @@ class APICursor
         @limit = nil
         @offset = 0
     end
-    
+
     def each()
         loop do
             item = self.next()
-            return if item == nil               
+            return if item == nil
             yield item
         end
     end
-    
+
     #
     # Limits the maximum number of entities fetched by this query.
     # 
@@ -60,7 +60,7 @@ class APICursor
         @limit = _limit
         self
     end
-    
+
     #
     # Returns the total count of entities matching the current query, without actually fetching
     # the entities themselves.
@@ -76,13 +76,13 @@ class APICursor
         if @count == -1
             params = @params.clone
             params['count'] = 1
-            
+
             res = @api.do_request("GET", @path, params)
             @count = res['count'].to_i
         end
         @count
     end
-    
+
     def all()
         to_a
     end
@@ -97,37 +97,41 @@ class APICursor
         return false if @limit != nil && @offset >= @limit
 
         load_next_page() if @data == nil
-            
+
         return true if @pos < @data.length
-        
+
         return false if !@truncated
-            
+
         load_next_page()
-        
+
         @pos < @data.length
     end
-    
+
     #
     # Returns the next entity in the result set.
     # 
     # Returns:
     #     Telerivet::Entity
     #
-    def next()             
+    def next()
         if @limit != nil && @offset >= @limit
             return nil
         end
-        
+
         if @data == nil || (@pos >= @data.length && @truncated)
             load_next_page()
         end
-        
+
         if @pos < @data.length
             item_data = @data[@pos]
             @pos += 1
             @offset += 1
             cls = @item_cls
-            return cls.new(@api, item_data, true)
+            if cls
+                return cls.new(@api, item_data, true)
+            else
+                return item_data
+            end
         else
             return nil
         end
@@ -135,17 +139,17 @@ class APICursor
 
     def load_next_page()
         request_params = @params.clone
-                
+
         if @next_marker != nil
             request_params['marker'] = @next_marker
         end
-        
+
         if @limit != nil && !request_params.has_key?("page_size")
             request_params['page_size'] = [@limit, 200].min
         end
-        
+
         response = @api.do_request("GET", @path, request_params)
-        
+
         @data = response['data']
         @truncated = response['truncated']
         @next_marker = response['next_marker']

data/lib/telerivet/broadcast.rb

@@ -75,7 +75,7 @@ module Telerivet
 #   
 #   - message_type
 #       * Type of message sent from this broadcast
-#       * Allowed values: sms, mms, ussd, call, service
+#       * Allowed values: sms, mms, ussd, ussd_session, call, chat, service
 #       * Read-only
 #   
 #   - content (string)
@@ -97,7 +97,7 @@ module Telerivet
 #       * Allowed values: female, male
 #       * Read-only
 #   
-#   - is_template (bool)
+#   - replace_variables (bool)
 #       * Set to true if Telerivet will render variables like [[contact.name]] in the message
 #           content, false otherwise
 #       * Read-only
@@ -257,8 +257,8 @@ class Broadcast < Entity
         get('tts_voice')
     end
 
-    def is_template
-        get('is_template')
+    def replace_variables
+        get('replace_variables')
     end
 
     def status

data/lib/telerivet/contact.rb

@@ -63,8 +63,8 @@ module Telerivet
 #       * Read-only
 #   
 #   - default_route_id
-#       * ID of the phone or route that Telerivet will use by default to send messages to this
-#           contact (null if using project default route)
+#       * ID of the basic route (phone) or custom route that Telerivet will use by default to
+#           send messages to this contact (null if using project default route)
 #       * Updatable via API
 #   
 #   - group_ids (array of strings)
@@ -134,7 +134,7 @@ class Contact < Entity
     #     
     #     - message_type
     #         * Filter messages by message_type
-    #         * Allowed values: sms, mms, ussd, call, service
+    #         * Allowed values: sms, mms, ussd, ussd_session, call, chat, service
     #     
     #     - source
     #         * Filter messages by source
@@ -253,7 +253,7 @@ class Contact < Entity
     #     
     #     - message_type
     #         * Filter scheduled messages by message_type
-    #         * Allowed values: sms, mms, ussd, call, service
+    #         * Allowed values: sms, mms, ussd, ussd_session, call, chat, service
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter scheduled messages by time_created
@@ -263,6 +263,9 @@ class Contact < Entity
     #         * Filter scheduled messages by next_time
     #         * Allowed modifiers: next_time[min], next_time[max], next_time[exists]
     #     
+    #     - relative_scheduled_id
+    #         * Filter scheduled messages created for a relative scheduled message
+    #     
     #     - sort
     #         * Sort the results based on a field
     #         * Allowed values: default, next_time

data/lib/telerivet/datatable.rb

@@ -176,8 +176,8 @@ class DataTable < Entity
     #     
     #     - type (string)
     #         * Field type
-    #         * Allowed values: text, long_text, phone_number, email, url, audio, date, date_time,
-    #             number, boolean, select
+    #         * Allowed values: text, long_text, secret, phone_number, email, url, audio, date,
+    #             date_time, number, boolean, checkbox, select, radio
     #     
     #     - order (int)
     #         * Order in which to display the field

data/lib/telerivet/group.rb

@@ -124,7 +124,7 @@ class Group < Entity
     #     
     #     - message_type
     #         * Filter scheduled messages by message_type
-    #         * Allowed values: sms, mms, ussd, call, service
+    #         * Allowed values: sms, mms, ussd, ussd_session, call, chat, service
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter scheduled messages by time_created
@@ -134,6 +134,9 @@ class Group < Entity
     #         * Filter scheduled messages by next_time
     #         * Allowed modifiers: next_time[min], next_time[max], next_time[exists]
     #     
+    #     - relative_scheduled_id
+    #         * Filter scheduled messages created for a relative scheduled message
+    #     
     #     - sort
     #         * Sort the results based on a field
     #         * Allowed values: default, next_time

data/lib/telerivet/label.rb

@@ -39,7 +39,7 @@ class Label < Entity
     #     
     #     - message_type
     #         * Filter messages by message_type
-    #         * Allowed values: sms, mms, ussd, call, service
+    #         * Allowed values: sms, mms, ussd, ussd_session, call, chat, service
     #     
     #     - source
     #         * Filter messages by source

data/lib/telerivet/message.rb

@@ -23,7 +23,7 @@ module Telerivet
 #   
 #   - message_type
 #       * Type of the message
-#       * Allowed values: sms, mms, ussd, call, service
+#       * Allowed values: sms, mms, ussd, ussd_session, call, chat, service
 #       * Read-only
 #   
 #   - source
@@ -93,8 +93,12 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - external_id
-#       * The ID of this message from an external SMS gateway provider (e.g. Twilio or Nexmo),
-#           if available.
+#       * The ID of this message from an external SMS gateway provider (e.g. Twilio or
+#           Vonage), if available.
+#       * Read-only
+#   
+#   - num_parts (number)
+#       * The number of SMS parts associated with the message, if applicable and if known.
 #       * Read-only
 #   
 #   - price (number)
@@ -144,6 +148,16 @@ module Telerivet
 #           undefined for messages that do not contain short URLs.
 #       * Read-only
 #   
+#   - network_code (string)
+#       * A string identifying the network that sent or received the message, if known. For
+#           mobile networks, this string contains the 3-digit mobile country code (MCC) followed
+#           by the 2- or 3-digit mobile network code (MNC), which results in a 5- or 6-digit
+#           number. For lists of mobile network operators and their corresponding MCC/MNC values,
+#           see [Mobile country code Wikipedia
+#           article](https://en.wikipedia.org/wiki/Mobile_country_code). The network_code property
+#           may be non-numeric for messages not sent via mobile networks.
+#       * Read-only
+#   
 #   - media (array)
 #       * For text messages containing media files, this is an array of objects with the
 #           properties `url`, `type` (MIME type), `filename`, and `size` (file size in bytes).
@@ -400,6 +414,10 @@ class Message < Entity
         get('external_id')
     end
 
+    def num_parts
+        get('num_parts')
+    end
+
     def price
         get('price')
     end
@@ -436,6 +454,10 @@ class Message < Entity
         get('short_urls')
     end
 
+    def network_code
+        get('network_code')
+    end
+
     def media
         get('media')
     end

data/lib/telerivet/organization.rb

@@ -15,11 +15,53 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - timezone_id
-#       * Billing quota time zone ID; see
-#           <http://en.wikipedia.org/wiki/List_of_tz_database_time_zones>
+#       * Billing quota time zone ID; see [List of tz database time zones Wikipedia
+#           article](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
 #       * Updatable via API
 #
 class Organization < Entity
+    #
+    # Creates a new project.
+    # 
+    # Some project settings are not currently possible to configure via
+    # the API, and can only be edited via the web app after the project is created.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - name (string)
+    #         * Name of the project to create, which must be unique in the organization.
+    #         * Required
+    #     
+    #     - timezone_id
+    #         * Default TZ database timezone ID; see [List of tz database time zones Wikipedia
+    #             article](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones). This timezone
+    #             is used when computing statistics by date.
+    #     
+    #     - url_slug
+    #         * Unique string used as a component of the project's URL in the Telerivet web app.
+    #             If not provided, a URL slug will be generated automatically.
+    #     
+    #     - auto_create_contacts (bool)
+    #         * If true, a contact will be automatically created for each unique phone number that
+    #             a message is sent to or received from. If false, contacts will not automatically be
+    #             created (unless contact information is modified by an automated service). The
+    #             Conversations tab in the web app will only show messages that are associated with a
+    #             contact.
+    #         * Default: 1
+    #     
+    #     - vars
+    #         * Custom variables and values to set for this project
+    #   
+    # Returns:
+    #     Telerivet::Project
+    #
+    def create_project(options)
+        require_relative 'project'
+        Project.new(@api, @api.do_request("POST", get_base_api_path() + "/projects", options))
+    end
+
     #
     # Saves any fields that have changed for this organization.
     #

data/lib/telerivet/phone.rb

@@ -2,7 +2,8 @@
 module Telerivet
 
 #
-# Represents a phone or gateway that you use to send/receive messages via Telerivet.
+# Represents a basic route (i.e. a phone or gateway) that you use to send/receive messages via
+# Telerivet.
 # 
 # Basic Routes were formerly referred to as "Phones" within Telerivet. API
 # methods, parameters, and properties related to Basic Routes continue to use the term "Phone"
@@ -73,15 +74,16 @@ module Telerivet
 #   
 #   - android_sdk (int)
 #       * Android SDK level, indicating the approximate version of the Android OS installed on
-#           this phone; see
-#           <http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels>
+#           this phone; see [list of Android SDK
+#           levels](http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
 #           (only present for Android phones)
 #       * Read-only
 #   
 #   - mccmnc
 #       * Code indicating the Android phone's current country (MCC) and mobile network
-#           operator (MNC); see <http://en.wikipedia.org/wiki/Mobile_country_code> (only present
-#           for Android phones). Note this is a string containing numeric digits, not an integer.
+#           operator (MNC); see [Mobile country code Wikipedia
+#           article](https://en.wikipedia.org/wiki/Mobile_country_code) (only present for Android
+#           phones). Note this is a string containing numeric digits, not an integer.
 #       * Read-only
 #   
 #   - manufacturer
@@ -100,7 +102,7 @@ module Telerivet
 #
 class Phone < Entity
     #
-    # Queries messages sent or received by this phone.
+    # Queries messages sent or received by this basic route.
     # 
     # Arguments:
     #   - options (Hash)
@@ -111,7 +113,7 @@ class Phone < Entity
     #     
     #     - message_type
     #         * Filter messages by message_type
-    #         * Allowed values: sms, mms, ussd, call, service
+    #         * Allowed values: sms, mms, ussd, ussd_session, call, chat, service
     #     
     #     - source
     #         * Filter messages by source
@@ -182,7 +184,7 @@ class Phone < Entity
     end
 
     #
-    # Saves any fields or custom variables that have changed for this phone.
+    # Saves any fields or custom variables that have changed for this basic route.
     #
     def save()
         super