telerivet 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e063e2ce507f6d45b86d12c584475887c050c3d439863d91d545b0ba331e823
-  data.tar.gz: d8040eb663854c7df190aa8f49984d9854687238532b6278af53dea6ebc77250
+  metadata.gz: 2276ff47e23f0670121a7295c0cf3d860740ebb0c1980de13e15ae2f25c2659d
+  data.tar.gz: 55db2507c8bcfa9f8ed0c3102f830dea689fd57ef57d0a00f1b488eebf46f4b5
 SHA512:
-  metadata.gz: da5e09e1c639a5e1bd3b704214c4a276d62469e6ae0853d71cbe4b9dc2a2aacbb1f58d5e5bcbf1093e5cbf24a7a99abcf30d029883aca055d4b41ae9f3a7f8ff
-  data.tar.gz: 4ad80ced036f9d8810e3e7f693443247740791ed4097b26ce179c2c2ef0ca06986b41942fde40401ea8989df19591f84834439efb74900f9bb57ec7f939d8f25
+  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
@@ -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

@@ -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
@@ -147,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
@@ -157,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
@@ -245,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[ne], next_time[min], next_time[max],
-    #             next_time[exists]
+    #         * 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
@@ -290,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

data/lib/telerivet/datatable.rb

@@ -55,7 +55,7 @@ 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
@@ -169,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, contact
+    #         * 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

@@ -54,24 +54,22 @@ class Group < Entity
     #     
     #     - 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[ne], last_message_time[min],
-    #             last_message_time[max], last_message_time[exists]
+    #         * 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[ne],
-    #             last_incoming_message_time[min], last_incoming_message_time[max],
-    #             last_incoming_message_time[exists]
+    #         * 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[ne],
-    #             last_outgoing_message_time[min], last_outgoing_message_time[max],
-    #             last_outgoing_message_time[exists]
+    #         * 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
@@ -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[ne], next_time[min], next_time[max],
-    #             next_time[exists]
+    #         * 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

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
@@ -52,7 +52,7 @@ class Label < 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
@@ -62,18 +62,26 @@ class Label < 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

data/lib/telerivet/message.rb

@@ -18,12 +18,12 @@ module Telerivet
 #   - status
 #       * Current status of the message
 #       * Allowed values: ignored, processing, received, sent, queued, failed, failed_queued,
-#           cancelled, delivered, not_delivered
+#           cancelled, delivered, not_delivered, read
 #       * Read-only
 #   
 #   - 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
@@ -71,6 +71,13 @@ module Telerivet
 #       * List of IDs of labels applied to this message
 #       * Read-only
 #   
+#   - route_params (Hash)
+#       * Route-specific parameters for the message. The parameters object may have keys
+#           matching the `phone_type` field of a phone (basic route) that may be used to send the
+#           message. The corresponding value is an object with route-specific parameters to use
+#           when the message is sent by that type of route.
+#       * Read-only
+#   
 #   - vars (Hash)
 #       * Custom variables stored for this message
 #       * Updatable via API
@@ -86,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)
@@ -122,15 +133,6 @@ module Telerivet
 #       * Allowed values: female, male
 #       * Read-only
 #   
-#   - mms_parts (array)
-#       * A list of parts in the MMS message, the same as returned by the
-#           [getMMSParts](#Message.getMMSParts) method.
-#           
-#           Note: This property is only present when retrieving an individual
-#           MMS message by ID, not when querying a list of messages. In other cases, use
-#           [getMMSParts](#Message.getMMSParts).
-#       * Read-only
-#   
 #   - track_clicks (boolean)
 #       * If true, URLs in the message content are short URLs that redirect to a destination
 #           URL.
@@ -138,12 +140,22 @@ module Telerivet
 #   
 #   - short_urls (array)
 #       * For text messages containing short URLs, this is an array of objects with the
-#           properties `short_url`, `link_type`, and `time_clicked` (the first time that URL was
-#           clicked). If `link_type` is "redirect", the object also contains a `destination_url`
-#           property. If `link_type` is "media", the object also contains an `media_index`
-#           property (the index in the media array). If `link_type` is "service", the object also
-#           contains a `service_id` property. This property is undefined for messages that do not
-#           contain short URLs.
+#           properties `short_url`, `link_type`, `time_clicked` (the first time that URL was
+#           clicked), and `expiration_time`. If `link_type` is "redirect", the object also
+#           contains a `destination_url` property. If `link_type` is "media", the object also
+#           contains an `media_index` property (the index in the media array). If `link_type` is
+#           "service", the object also contains a `service_id` property. This property is
+#           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)
@@ -154,6 +166,27 @@ module Telerivet
 #           temporary and may not be valid for more than 1 day.
 #       * Read-only
 #   
+#   - mms_parts (array)
+#       * A list of parts in the MMS message (only for incoming MMS messages received via
+#           Telerivet Gateway Android app).
+#           
+#           Each MMS part in the list is an object with the following
+#           properties:
+#           
+#           - cid: MMS content-id
+#           - type: MIME type
+#           - filename: original filename
+#           - size (int): number of bytes
+#           - url: URL where the content for this part is stored (secret but
+#           publicly accessible, so you could link/embed it in a web page without having to
+#           re-host it yourself)
+#           
+#           In general, the `media` property of the message is recommended for
+#           retrieving information about MMS media files, instead of `mms_parts`.
+#           The `mms_parts` property is also only present when retrieving an
+#           individual MMS message by ID, not when querying a list of messages.
+#       * Read-only
+#   
 #   - time_clicked (UNIX timestamp)
 #       * If the message contains any short URLs, this is the first time that a short URL in
 #           the message was clicked.  This property is undefined for messages that do not contain
@@ -237,18 +270,15 @@ class Message < Entity
     end
 
     #
-    # Retrieves a list of MMS parts for this message (empty for non-MMS messages).
+    # (Deprecated) Retrieves a list of MMS parts for this message (only for incoming MMS messages
+    # received via Telerivet Gateway Android app).
+    # Note: This only works for MMS messages received via the Telerivet
+    # Gateway Android app.
+    # In general, the `media` property of the message is recommended for
+    # retrieving information about MMS media files.
     # 
-    # Each MMS part in the list is an object with the following
-    # properties:
-    # 
-    # - cid: MMS content-id
-    # - type: MIME type
-    # - filename: original filename
-    # - size (int): number of bytes
-    # - url: URL where the content for this part is stored (secret but
-    # publicly accessible, so you could link/embed it in a web page without having to re-host it
-    # yourself)
+    # The return value has the same format as the `mms_parts` property of
+    # the Message object.
     # 
     # Returns:
     #     array
@@ -364,6 +394,10 @@ class Message < Entity
         get('label_ids')
     end
 
+    def route_params
+        get('route_params')
+    end
+
     def priority
         get('priority')
     end
@@ -380,6 +414,10 @@ class Message < Entity
         get('external_id')
     end
 
+    def num_parts
+        get('num_parts')
+    end
+
     def price
         get('price')
     end
@@ -408,10 +446,6 @@ class Message < Entity
         get('tts_voice')
     end
 
-    def mms_parts
-        get('mms_parts')
-    end
-
     def track_clicks
         get('track_clicks')
     end
@@ -420,10 +454,18 @@ class Message < Entity
         get('short_urls')
     end
 
+    def network_code
+        get('network_code')
+    end
+
     def media
         get('media')
     end
 
+    def mms_parts
+        get('mms_parts')
+    end
+
     def time_clicked
         get('time_clicked')
     end