telerivet 1.4.5 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0633af0317a3ef409a86481a483f934d2832d2f6a11fd545221997c3ebb495ad
-  data.tar.gz: 344a694d8cc84a5231cefa14d26f89fceecf6d140f201e013705794684f94015
+  metadata.gz: 2276ff47e23f0670121a7295c0cf3d860740ebb0c1980de13e15ae2f25c2659d
+  data.tar.gz: 55db2507c8bcfa9f8ed0c3102f830dea689fd57ef57d0a00f1b488eebf46f4b5
 SHA512:
-  metadata.gz: 74a877df3a572e3b1d96922343d0bc54ed58a2f2d28b36bf883691a3b440244e777cdb74cfed10f701a2f8a768dd157e5ada0f116b1c588774744080699fabc8
-  data.tar.gz: b75d13f319943c2f899200a1845932aad01205a902b280c2128d8bf19c7453b696386a539c278df2a1a19cba14c018189a817a622f2897d229b63eba3f94b7f3
+  metadata.gz: cdd68937b393e61a1ec76e536b0abfcf30e3bb16127b2ea6a37f221013c8ee9d43aa99f5bf758eeb70d04c0366ffcfe1a2e4af576d0620507412b92ac8ceeab7
+  data.tar.gz: 50cf5362c2926a104d8e1d6cd15ee5473589cdf31e78e516f9e6ad1af335baec040de5b5cf8598dc8e95008e08fe9775a448da465fffc708030b8e217d86e52a

data/lib/telerivet/airtimetransaction.rb

@@ -0,0 +1,155 @@
+
+module Telerivet
+
+#
+# Represents a transaction where airtime is sent to a mobile phone number.
+# 
+# To send airtime, first [create a Custom Actions service to send a particular amount of
+# airtime](/dashboard/add_service?subtype_id=main.service.rules.contact&action_id=main.rule.sendairtime),
+# then trigger the service using [service.invoke](#Service.invoke),
+# [project.sendBroadcast](#Project.sendBroadcast), or
+# [project.scheduleMessage](#Project.scheduleMessage).
+# 
+# Fields:
+# 
+#   - id
+#       * ID of the airtime transaction
+#       * Read-only
+#   
+#   - to_number
+#       * Destination phone number in international format (no leading +)
+#       * Read-only
+#   
+#   - operator_name
+#       * Operator name
+#       * Read-only
+#   
+#   - country
+#       * 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`)
+#       * Read-only
+#   
+#   - status_text
+#       * Error or success message returned by airtime provider, if available
+#       * Read-only
+#   
+#   - value
+#       * Value of airtime sent to destination phone number, in units of value_currency
+#       * Read-only
+#   
+#   - value_currency
+#       * Currency code of price
+#       * Read-only
+#   
+#   - price
+#       * Price charged for airtime transaction, in units of price_currency
+#       * Read-only
+#   
+#   - price_currency
+#       * Currency code of price
+#       * Read-only
+#   
+#   - contact_id
+#       * ID of the contact the airtime was sent to
+#       * Read-only
+#   
+#   - service_id
+#       * ID of the service that sent the airtime
+#       * Read-only
+#   
+#   - project_id
+#       * ID of the project that the airtime transaction belongs to
+#       * Read-only
+#   
+#   - external_id
+#       * The ID of this transaction from an external airtime gateway provider, if available.
+#       * Read-only
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this transaction
+#       * Updatable via API
+#
+class AirtimeTransaction < Entity
+    def id
+        get('id')
+    end
+
+    def to_number
+        get('to_number')
+    end
+
+    def operator_name
+        get('operator_name')
+    end
+
+    def country
+        get('country')
+    end
+
+    def time_created
+        get('time_created')
+    end
+
+    def transaction_time
+        get('transaction_time')
+    end
+
+    def status
+        get('status')
+    end
+
+    def status_text
+        get('status_text')
+    end
+
+    def value
+        get('value')
+    end
+
+    def value_currency
+        get('value_currency')
+    end
+
+    def price
+        get('price')
+    end
+
+    def price_currency
+        get('price_currency')
+    end
+
+    def contact_id
+        get('contact_id')
+    end
+
+    def service_id
+        get('service_id')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def external_id
+        get('external_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/airtime_transactions/#{get('id')}"
+    end
+ 
+end
+
+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
@@ -109,7 +109,7 @@ module Telerivet
 #   
 #   - source
 #       * How the message originated within Telerivet
-#       * Allowed values: phone, provider, web, api, service, webhook, scheduled
+#       * Allowed values: phone, provider, web, api, service, webhook, scheduled, integration
 #       * Read-only
 #   
 #   - simulated (bool)
@@ -144,6 +144,13 @@ module Telerivet
 #       * Custom variables stored for this broadcast
 #       * Read-only
 #   
+#   - route_params (Hash)
+#       * Route-specific parameters for the messages in the broadcast. The parameters object
+#           may have keys matching the `phone_type` field of a phone (basic route) that may be
+#           used to send messages in this broadcast. The corresponding value is an object with
+#           route-specific parameters to use when sending messages with that type of route.
+#       * Read-only
+#   
 #   - price (number)
 #       * The total price of all messages in this broadcast, if known.
 #       * Read-only
@@ -250,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
@@ -282,6 +289,10 @@ class Broadcast < Entity
         get('media')
     end
 
+    def route_params
+        get('route_params')
+    end
+
     def price
         get('price')
     end

data/lib/telerivet/contact.rb

@@ -27,6 +27,11 @@ module Telerivet
 #       * True if Telerivet is blocked from sending messages to this contact
 #       * Updatable via API
 #   
+#   - conversation_status
+#       * Current status of the conversation with this contact
+#       * Allowed values: closed, active, handled
+#       * 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)
@@ -58,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)
@@ -129,11 +134,12 @@ 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
-    #         * 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
@@ -141,7 +147,7 @@ class Contact < 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
@@ -151,18 +157,26 @@ class Contact < 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
@@ -239,20 +253,22 @@ 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
-    #         * Allowed modifiers: time_created[ne], time_created[min], time_created[max]
+    #         * Allowed modifiers: time_created[min], time_created[max]
     #     
     #     - next_time (UNIX timestamp)
     #         * Filter scheduled messages by next_time
-    #         * Allowed modifiers: next_time[exists], next_time[ne], next_time[min],
-    #             next_time[max]
+    #         * 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, name
+    #         * Allowed values: default, next_time
     #         * Default: default
     #     
     #     - sort_dir
@@ -284,7 +300,7 @@ class Contact < Entity
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter data rows by the time they were created
-    #         * Allowed modifiers: time_created[ne], time_created[min], time_created[max]
+    #         * Allowed modifiers: time_created[min], time_created[max]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -325,9 +341,9 @@ class Contact < Entity
     #     
     #     - vars (Hash)
     #         * Filter states by value of a custom variable (e.g. vars[email], 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]
+    #         * Allowed modifiers: 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], vars[foo][exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -405,6 +421,14 @@ class Contact < Entity
         set('send_blocked', value)
     end
 
+    def conversation_status
+        get('conversation_status')
+    end
+
+    def conversation_status=(value)
+        set('conversation_status', value)
+    end
+
     def last_message_time
         get('last_message_time')
     end

data/lib/telerivet/datatable.rb

@@ -22,7 +22,8 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - num_rows (int)
-#       * Number of rows in the table
+#       * Number of rows in the table. For performance reasons, this number may sometimes be
+#           out-of-date.
 #       * Read-only
 #   
 #   - show_add_row (bool)
@@ -54,16 +55,16 @@ class DataTable < Entity
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter data rows by the time they were created
-    #         * Allowed modifiers: time_created[ne], time_created[min], time_created[max]
+    #         * Allowed modifiers: time_created[min], time_created[max]
     #     
     #     - contact_id
     #         * Filter data rows associated with a particular contact
     #     
     #     - 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]
+    #         * Allowed modifiers: 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], vars[foo][exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -168,25 +169,36 @@ class DataTable < Entity
     #       * Required
     #   
     #   - options (Hash)
+    #       * Required
     #     
     #     - name (string, max 64 characters)
     #         * Display name for the field
     #     
     #     - type (string)
     #         * Field type
-    #         * Allowed values: text, long_text, number, boolean, email, url, audio, phone_number,
-    #             date, date_time, groups, route, select, buttons
+    #         * 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
     #     
+    #     - items (array)
+    #         * Array of up to 100 objects containing `value` and `label` string properties to
+    #             show in the dropdown list when type is `select`. Each `value` and `label` must be
+    #             between 1 and 256 characters in length.
+    #         * Required if type is `select`
+    #     
     #     - readonly (bool)
     #         * Set to true to prevent editing the field in the Telerivet web app
+    #     
+    #     - lookup_key (bool)
+    #         * Set to true to allow using this field as a lookup key when importing rows via the
+    #             Telerivet web app
     #   
     # Returns:
     #     object
     #
-    def set_field_metadata(variable, options = nil)
+    def set_field_metadata(variable, options)
         return @api.do_request("POST", get_base_api_path() + "/fields/#{variable}", options)
     end
 

data/lib/telerivet/group.rb

@@ -50,28 +50,26 @@ class Group < Entity
     #         * Filter contacts by phone number
     #         * Allowed modifiers: phone_number[ne], phone_number[prefix],
     #             phone_number[not_prefix], phone_number[gte], phone_number[gt], phone_number[lt],
-    #             phone_number[lte]
+    #             phone_number[lte], phone_number[exists]
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter contacts by time created
-    #         * Allowed modifiers: time_created[ne], time_created[min], time_created[max]
+    #         * Allowed modifiers: time_created[min], time_created[max]
     #     
     #     - last_message_time (UNIX timestamp)
     #         * Filter contacts by last time a message was sent or received
-    #         * Allowed modifiers: last_message_time[exists], last_message_time[ne],
-    #             last_message_time[min], last_message_time[max]
+    #         * Allowed modifiers: last_message_time[min], last_message_time[max],
+    #             last_message_time[exists]
     #     
     #     - 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]
+    #         * Allowed modifiers: last_incoming_message_time[min],
+    #             last_incoming_message_time[max], last_incoming_message_time[exists]
     #     
     #     - 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]
+    #         * Allowed modifiers: last_outgoing_message_time[min],
+    #             last_outgoing_message_time[max], last_outgoing_message_time[exists]
     #     
     #     - incoming_message_count (int)
     #         * Filter contacts by number of messages received from the contact
@@ -88,9 +86,9 @@ class Group < Entity
     #     
     #     - 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],
-    #             vars[foo][not_prefix], vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte],
-    #             vars[foo][min], vars[foo][max]
+    #         * Allowed modifiers: 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], vars[foo][exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -126,20 +124,22 @@ 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
-    #         * Allowed modifiers: time_created[ne], time_created[min], time_created[max]
+    #         * Allowed modifiers: time_created[min], time_created[max]
     #     
     #     - next_time (UNIX timestamp)
     #         * Filter scheduled messages by next_time
-    #         * Allowed modifiers: next_time[exists], next_time[ne], next_time[min],
-    #             next_time[max]
+    #         * 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, name
+    #         * Allowed values: default, next_time
     #         * Default: default
     #     
     #     - sort_dir