telerivet 1.6.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 303a6df0ce9d23233621cac3732ab09afb1b9bf968d784441e29bd343a4ec105
-  data.tar.gz: fad6a45b9e7b0cd84668f49a129a6600b3fcd4898b18d193d476deede36c9323
+  metadata.gz: 53eb2eb3eda20f383f980d2b94f38955f16ae139b588b14ad547dbbd371642f9
+  data.tar.gz: d65a986a9fa2e2ed62bb0245595ad7d3d76bc607774f13314efd64b4d2405762
 SHA512:
-  metadata.gz: 4b030343b0e5d79d4c1d520d348baccfe77a7d171fab5b86f1f3a0b16e914f82ad3c5eab796fd2ddcec3480a1f952e030208f5db2eaaa568b3eb079fddbaa1ca
-  data.tar.gz: a8c12e9cfbb08f568f40cb4647646d033aa55d1864b1acd28219ff27d587d04ef2bff994b8aa0ab43c3082446de03bebe2ad90a99ba25a22ea40700505954e68
+  metadata.gz: 748e80a811e0791268fb144fec9eca46e8c0beaea561d616a21c01b461d3baf4ca1063ead62ed9c6b9ce9070036f3db46b133878bc2d021dad8b7d010cf24d89
+  data.tar.gz: 85630bd869da8d7a42c0ef137d2e95c583b47796e4efbe581c86ebf15542022a08f2d27d42a97b5efc7007008525ad5ba5756a4f714b86ab4b6ef734deac200d

data/lib/telerivet/airtimetransaction.rb

@@ -28,9 +28,17 @@ 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`)
+#           `queued`, `processing`, `submitted`, `pending_approval`, or `pending_payment`)
 #       * Read-only
 #   
 #   - status_text
@@ -69,8 +77,17 @@ module Telerivet
 #       * The ID of this transaction from an external airtime gateway provider, if available.
 #       * Read-only
 #   
+#   - user_id (string, max 34 characters)
+#       * ID of the Telerivet user who sent the airtime transaction (if applicable)
+#       * Read-only
+#   
 #   - vars (Hash)
-#       * Custom variables stored for this transaction
+#       * Custom variables stored for this transaction. Variable names may be up to 32
+#           characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #
 class AirtimeTransaction < Entity
@@ -90,6 +107,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
@@ -130,6 +155,10 @@ class AirtimeTransaction < Entity
         get('external_id')
     end
 
+    def user_id
+        get('user_id')
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/airtime_transactions/#{get('id')}"
     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
@@ -141,14 +141,22 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this broadcast
+#       * Custom variables stored for this broadcast. Variable names may be up to 32
+#           characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * 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.
+#       * Route-specific parameters for the messages in the broadcast.
+#           
+#           When sending messages via chat apps such as WhatsApp, the route_params
+#           parameter can be used to send messages with app-specific features such as quick
+#           replies and link buttons.
+#           
+#           For more details, see [Route-Specific Parameters](#route_params).
 #       * Read-only
 #   
 #   - price (number)
@@ -257,8 +265,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)
@@ -72,7 +72,12 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this contact
+#       * Custom variables stored for this contact. Variable names may be up to 32 characters
+#           in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id
@@ -134,7 +139,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 +258,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 +268,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/contactservicestate.rb

@@ -40,7 +40,12 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this contact/service state
+#       * Custom variables stored for this contact/service state. Variable names may be up to
+#           32 characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - time_created (UNIX timestamp)

data/lib/telerivet/datarow.rb

@@ -28,7 +28,12 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this data row
+#       * Custom variables stored for this data row. Variable names may be up to 32 characters
+#           in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - time_created (UNIX timestamp)

data/lib/telerivet/datatable.rb

@@ -31,7 +31,8 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - show_stats (bool)
-#       * Whether to show row statistics in the web app
+#       * Whether to show summary charts (pie charts, bar charts, tables of top values) for
+#           this data table in the web app
 #       * Updatable via API
 #   
 #   - show_contact_columns (bool)
@@ -39,7 +40,12 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this data table
+#       * Custom variables stored for this data table. Variable names may be up to 32
+#           characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id
@@ -105,7 +111,12 @@ class DataTable < Entity
     #         * Phone number that this row is associated with (if applicable)
     #     
     #     - vars
-    #         * Custom variables and values to set for this data row
+    #         * Custom variables and values to set for this data row. Variable names may be up to
+    #             32 characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+    #             Values may be strings, numbers, or boolean (true/false).
+    #             String values may be up to 4096 bytes in length when encoded as UTF-8.
+    #             Up to 100 variables are supported per object.
+    #             Setting a variable to null will delete the variable.
     #   
     # Returns:
     #     Telerivet::DataRow
@@ -163,6 +174,9 @@ class DataTable < Entity
     #
     # Allows customizing how a field (column) is displayed in the Telerivet web app.
     # 
+    # The variable path parameter can contain the characters a-z, A-Z,
+    # 0-9, and _, and may be up to 32 characters in length.
+    # 
     # Arguments:
     #   - variable
     #       * The variable name of the field to create or update.
@@ -176,8 +190,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, route
     #     
     #     - order (int)
     #         * Order in which to display the field

data/lib/telerivet/group.rb

@@ -26,8 +26,23 @@ module Telerivet
 #       * Time the group was created in Telerivet
 #       * Read-only
 #   
+#   - allow_sending (bool)
+#       * True if messages can be sent to this group, false otherwise.
+#       * Updatable via API
+#   
+#   - add_time_variable (string)
+#       * Variable name of a custom contact field that will automatically be set to the
+#           current date/time on any contact that is added to the group. This variable will only
+#           be set if the contact does not already have a value for this variable.
+#       * Updatable via API
+#   
 #   - vars (Hash)
-#       * Custom variables stored for this group
+#       * Custom variables stored for this group. Variable names may be up to 32 characters in
+#           length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id
@@ -124,7 +139,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 +149,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
@@ -198,6 +216,22 @@ class Group < Entity
         get('time_created')
     end
 
+    def allow_sending
+        get('allow_sending')
+    end
+
+    def allow_sending=(value)
+        set('allow_sending', value)
+    end
+
+    def add_time_variable
+        get('add_time_variable')
+    end
+
+    def add_time_variable=(value)
+        set('add_time_variable', value)
+    end
+
     def project_id
         get('project_id')
     end

data/lib/telerivet/label.rb

@@ -19,7 +19,12 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this label
+#       * Custom variables stored for this label. Variable names may be up to 32 characters in
+#           length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id
@@ -39,7 +44,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
@@ -72,14 +72,22 @@ module Telerivet
 #       * 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.
+#       * Route-specific parameters for the message.
+#           
+#           When sending messages via chat apps such as WhatsApp, the route_params
+#           parameter can be used to send messages with app-specific features such as quick
+#           replies and link buttons.
+#           
+#           For more details, see [Route-Specific Parameters](#route_params).
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this message
+#       * Custom variables stored for this message. Variable names may be up to 32 characters
+#           in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - priority (int)
@@ -92,9 +100,20 @@ module Telerivet
 #           omitted from the API response if there is no error message.)
 #       * Updatable via API
 #   
+#   - error_code
+#       * A route-specific error code encountered while sending a message. The error code
+#           values depend on the provider and may be described in the provider's API
+#           documentation. Error codes may be strings or numbers, depending on the provider. (This
+#           field is omitted from the API response if there is no error code.)
+#       * Read-only
+#   
 #   - 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 +163,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).
@@ -396,10 +425,18 @@ class Message < Entity
         set('error_message', value)
     end
 
+    def error_code
+        get('error_code')
+    end
+
     def external_id
         get('external_id')
     end
 
+    def num_parts
+        get('num_parts')
+    end
+
     def price
         get('price')
     end
@@ -436,6 +473,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.
     #