telerivet 1.3.0 → 1.4.6

data/lib/telerivet/datatable.rb

@@ -25,6 +25,18 @@ module Telerivet
 #       * Number of rows in the table
 #       * Read-only
 #   
+#   - show_add_row (bool)
+#       * Whether to allow adding or importing rows via the web app
+#       * Updatable via API
+#   
+#   - show_stats (bool)
+#       * Whether to show row statistics in the web app
+#       * Updatable via API
+#   
+#   - show_contact_columns (bool)
+#       * Whether to show 'Contact Name' and 'Phone Number' columns in the web app
+#       * Updatable via API
+#   
 #   - vars (Hash)
 #       * Custom variables stored for this data table
 #       * Updatable via API
@@ -64,7 +76,7 @@ class DataTable < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -136,8 +148,9 @@ class DataTable < Entity
 
     #
     # Gets a list of all fields (columns) defined for this data table. The return value is an
-    # array of objects with the properties 'name' and 'variable'. (Fields are automatically
-    # created any time a DataRow's 'vars' property is updated.)
+    # array of objects with the properties 'name', 'variable', 'type', 'order', 'readonly', and
+    # 'lookup_key'. (Fields are automatically created any time a DataRow's 'vars' property is
+    # updated.)
     # 
     # Returns:
     #     array
@@ -146,6 +159,37 @@ class DataTable < Entity
         return @api.do_request("GET", get_base_api_path() + "/fields")
     end
 
+    #
+    # Allows customizing how a field (column) is displayed in the Telerivet web app.
+    # 
+    # Arguments:
+    #   - variable
+    #       * The variable name of the field to create or update.
+    #       * Required
+    #   
+    #   - options (Hash)
+    #     
+    #     - 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
+    #     
+    #     - order (int)
+    #         * Order in which to display the field
+    #     
+    #     - readonly (bool)
+    #         * Set to true to prevent editing the field in the Telerivet web app
+    #   
+    # Returns:
+    #     object
+    #
+    def set_field_metadata(variable, options = nil)
+        return @api.do_request("POST", get_base_api_path() + "/fields/#{variable}", options)
+    end
+
     #
     # Returns the number of rows for each value of a given variable. This can be used to get the
     # total number of responses for each choice in a poll, without making a separate query for
@@ -194,6 +238,30 @@ class DataTable < Entity
         get('num_rows')
     end
 
+    def show_add_row
+        get('show_add_row')
+    end
+
+    def show_add_row=(value)
+        set('show_add_row', value)
+    end
+
+    def show_stats
+        get('show_stats')
+    end
+
+    def show_stats=(value)
+        set('show_stats', value)
+    end
+
+    def show_contact_columns
+        get('show_contact_columns')
+    end
+
+    def show_contact_columns=(value)
+        set('show_contact_columns', value)
+    end
+
     def project_id
         get('project_id')
     end

data/lib/telerivet/group.rb

@@ -103,7 +103,7 @@ class Group < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -126,7 +126,7 @@ class Group < Entity
     #     
     #     - message_type
     #         * Filter scheduled messages by message_type
-    #         * Allowed values: sms, mms, ussd, call
+    #         * Allowed values: sms, mms, ussd, call, service
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter scheduled messages by time_created
@@ -148,7 +148,7 @@ class Group < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)

data/lib/telerivet/label.rb

@@ -39,11 +39,12 @@ class Label < Entity
     #     
     #     - message_type
     #         * Filter messages by message_type
-    #         * Allowed values: sms, mms, ussd, call
+    #         * Allowed values: sms, mms, ussd, call, 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
@@ -66,7 +67,13 @@ class Label < Entity
     #         * ID of the contact who sent/received the message
     #     
     #     - phone_id
-    #         * ID of the phone that sent/received the message
+    #         * ID of the phone (basic route) that sent/received the message
+    #     
+    #     - broadcast_id
+    #         * ID of the broadcast containing the message
+    #     
+    #     - scheduled_id
+    #         * ID of the scheduled message that created this message
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -79,7 +86,7 @@ class Label < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)

data/lib/telerivet/message.rb

@@ -23,12 +23,12 @@ module Telerivet
 #   
 #   - message_type
 #       * Type of the message
-#       * Allowed values: sms, mms, ussd, call
+#       * Allowed values: sms, mms, ussd, call, service
 #       * Read-only
 #   
 #   - 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
 #   
 #   - time_created (UNIX timestamp)
@@ -40,6 +40,10 @@ module Telerivet
 #           and messages that have not yet been sent)
 #       * Read-only
 #   
+#   - time_updated (UNIX timestamp)
+#       * The time that the message was last updated in Telerivet.
+#       * Read-only
+#   
 #   - from_number (string)
 #       * The phone number that the message originated from (your number for outgoing
 #           messages, the contact's number for incoming messages)
@@ -71,6 +75,11 @@ module Telerivet
 #       * Custom variables stored for this message
 #       * Updatable via API
 #   
+#   - priority (int)
+#       * Priority of this message. Telerivet will attempt to send messages with higher
+#           priority numbers first. Only defined for outgoing messages.
+#       * Read-only
+#   
 #   - error_message
 #       * A description of the error encountered while sending a message. (This field is
 #           omitted from the API response if there is no error message.)
@@ -122,13 +131,42 @@ module Telerivet
 #           [getMMSParts](#Message.getMMSParts).
 #       * Read-only
 #   
+#   - track_clicks (boolean)
+#       * If true, URLs in the message content are short URLs that redirect to a destination
+#           URL.
+#       * Read-only
+#   
+#   - 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.
+#       * 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).
+#           Unknown properties are null. This property is undefined for messages that do not
+#           contain media files. Note: For files uploaded via the Telerivet web app, the URL is
+#           temporary and may not be valid for more than 1 day.
+#       * 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
+#           short URLs.
+#       * Read-only
+#   
 #   - service_id (string, max 34 characters)
 #       * ID of the service that handled the message (for voice calls, the service defines the
 #           call flow)
 #       * Read-only
 #   
 #   - phone_id (string, max 34 characters)
-#       * ID of the phone that sent or received the message
+#       * ID of the phone (basic route) that sent or received the message
 #       * Read-only
 #   
 #   - contact_id (string, max 34 characters)
@@ -136,13 +174,17 @@ module Telerivet
 #       * Read-only
 #   
 #   - route_id (string, max 34 characters)
-#       * ID of the route that sent the message (if applicable)
+#       * ID of the custom route that sent the message (if applicable)
 #       * Read-only
 #   
 #   - broadcast_id (string, max 34 characters)
 #       * ID of the broadcast that this message is part of (if applicable)
 #       * Read-only
 #   
+#   - scheduled_id (string, max 34 characters)
+#       * ID of the scheduled message that created this message is part of (if applicable)
+#       * Read-only
+#   
 #   - user_id (string, max 34 characters)
 #       * ID of the Telerivet user who sent the message (if applicable)
 #       * Read-only
@@ -290,6 +332,10 @@ class Message < Entity
         get('time_sent')
     end
 
+    def time_updated
+        get('time_updated')
+    end
+
     def from_number
         get('from_number')
     end
@@ -318,6 +364,10 @@ class Message < Entity
         get('label_ids')
     end
 
+    def priority
+        get('priority')
+    end
+
     def error_message
         get('error_message')
     end
@@ -362,6 +412,22 @@ class Message < Entity
         get('mms_parts')
     end
 
+    def track_clicks
+        get('track_clicks')
+    end
+
+    def short_urls
+        get('short_urls')
+    end
+
+    def media
+        get('media')
+    end
+
+    def time_clicked
+        get('time_clicked')
+    end
+
     def service_id
         get('service_id')
     end
@@ -382,6 +448,10 @@ class Message < Entity
         get('broadcast_id')
     end
 
+    def scheduled_id
+        get('scheduled_id')
+    end
+
     def user_id
         get('user_id')
     end

data/lib/telerivet/organization.rb

@@ -120,7 +120,7 @@ class Organization < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)

data/lib/telerivet/phone.rb

@@ -4,6 +4,10 @@ module Telerivet
 #
 # Represents 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"
+# to maintain backwards compatibility.
+# 
 # Fields:
 # 
 #   - id (string, max 34 characters)
@@ -15,11 +19,11 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - phone_number (string)
-#       * Phone number of the phone
+#       * Phone number or sender ID
 #       * Updatable via API
 #   
 #   - phone_type
-#       * Type of this phone/gateway (e.g. android, twilio, nexmo, etc)
+#       * Type of this phone/route (e.g. android, twilio, nexmo, etc)
 #       * Read-only
 #   
 #   - country
@@ -107,11 +111,12 @@ class Phone < Entity
     #     
     #     - message_type
     #         * Filter messages by message_type
-    #         * Allowed values: sms, mms, ussd, call
+    #         * Allowed values: sms, mms, ussd, call, 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
@@ -134,7 +139,13 @@ class Phone < Entity
     #         * ID of the contact who sent/received the message
     #     
     #     - phone_id
-    #         * ID of the phone that sent/received the message
+    #         * ID of the phone (basic route) that sent/received the message
+    #     
+    #     - broadcast_id
+    #         * ID of the broadcast containing the message
+    #     
+    #     - scheduled_id
+    #         * ID of the scheduled message that created this message
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -147,7 +158,7 @@ class Phone < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)

data/lib/telerivet/project.rb

@@ -37,16 +37,17 @@ module Telerivet
 #
 class Project < Entity
     #
-    # Sends one message (SMS, voice call, or USSD request).
+    # Sends one message (SMS, MMS, voice call, or USSD request).
     # 
     # Arguments:
     #   - options (Hash)
     #       * Required
     #     
     #     - message_type
-    #         * Type of message to send
-    #         * Allowed values: sms, ussd, call
-    #         * Default: sms
+    #         * Type of message to send. If `text`, will use the default text message type for the
+    #             selected route.
+    #         * Allowed values: sms, mms, ussd, call, text
+    #         * Default: text
     #     
     #     - content
     #         * Content of the message to send (if `message_type` is `call`, the text will be
@@ -63,7 +64,46 @@ class Project < Entity
     #     
     #     - route_id
     #         * ID of the phone or route to send the message from
-    #         * Default: default sender phone ID for your project
+    #         * Default: default sender route ID for your project
+    #     
+    #     - status_url
+    #         * Webhook callback URL to be notified when message status changes
+    #     
+    #     - status_secret
+    #         * POST parameter 'secret' passed to status_url
+    #     
+    #     - is_template (bool)
+    #         * Set to true to evaluate variables like [[contact.name]] in message content. [(See
+    #             available variables)](#variables)
+    #         * Default: false
+    #     
+    #     - track_clicks (boolean)
+    #         * If true, URLs in the message content will automatically be replaced with unique
+    #             short URLs.
+    #         * Default: false
+    #     
+    #     - media_urls (array)
+    #         * URLs of media files to attach to the text message. If `message_type` is `sms`,
+    #             short links to each media URL will be appended to the end of the content (separated
+    #             by a new line).
+    #     
+    #     - label_ids (array)
+    #         * List of IDs of labels to add to this message
+    #     
+    #     - vars (Hash)
+    #         * Custom variables to store with the message
+    #     
+    #     - priority (int)
+    #         * Priority of the message. Telerivet will attempt to send messages with higher
+    #             priority numbers first (for example, so you can prioritize an auto-reply ahead of a
+    #             bulk message to a large group).
+    #         * Allowed values: 1, 2
+    #         * Default: 1
+    #     
+    #     - simulated (bool)
+    #         * Set to true to test the Telerivet API without actually sending a message from the
+    #             route
+    #         * Default: false
     #     
     #     - service_id
     #         * Service that defines the call flow of the voice call (when `message_type` is
@@ -90,37 +130,6 @@ class Project < Entity
     #         * The name of the text-to-speech voice (when message_type=call)
     #         * Allowed values: female, male
     #         * Default: female
-    #     
-    #     - status_url
-    #         * Webhook callback URL to be notified when message status changes
-    #     
-    #     - status_secret
-    #         * POST parameter 'secret' passed to status_url
-    #     
-    #     - is_template (bool)
-    #         * Set to true to evaluate variables like [[contact.name]] in message content. [(See
-    #             available variables)](#variables)
-    #         * Default: false
-    #     
-    #     - label_ids (array)
-    #         * List of IDs of labels to add to this message
-    #     
-    #     - vars (Hash)
-    #         * Custom variables to store with the message
-    #     
-    #     - priority (int)
-    #         * Priority of the message (currently only observed for Android phones). Telerivet
-    #             will attempt to send messages with higher priority numbers first (for example, so
-    #             you can prioritize an auto-reply ahead of a bulk message to a large group).
-    #         * Default: 1
-    #     
-    #     - user_id
-    #         * ID of the Telerivet user account that sent the message (use
-    #             [project.getUsers](#Project.getUsers) to look up user IDs). In order to use this
-    #             parameter, the user account associated with the API key must have administrator
-    #             permissions for the project, and the user account associated with the user_id
-    #             parameter must have access to the project.
-    #         * Default: User account associated with the API key
     #   
     # Returns:
     #     Telerivet::Message
@@ -131,17 +140,22 @@ class Project < Entity
     end
 
     #
-    # Sends an SMS message (optionally with mail-merge templates) or voice call to a group or a
-    # list of up to 500 phone numbers
+    # Sends a text message (optionally with mail-merge templates) or voice call to a group or a
+    # list of up to 500 phone numbers.
+    # 
+    # With `message_type`=`service`, invokes an automated service (such as
+    # a poll) for a group or list of phone numbers. Any service that can be triggered for a
+    # contact can be invoked via this method, whether or not the service actually sends a message.
     # 
     # Arguments:
     #   - options (Hash)
     #       * Required
     #     
     #     - message_type
-    #         * Type of message to send
-    #         * Allowed values: sms, call
-    #         * Default: sms
+    #         * Type of message to send. If `text`, will use the default text message type for the
+    #             selected route.
+    #         * Allowed values: sms, mms, call, service, text
+    #         * Default: text
     #     
     #     - content
     #         * Content of the message to send
@@ -157,11 +171,48 @@ class Project < Entity
     #     
     #     - route_id
     #         * ID of the phone or route to send the message from
-    #         * Default: default sender phone ID
+    #         * Default: default sender route ID
+    #     
+    #     - title (string)
+    #         * Title of the broadcast. If a title is not provided, a title will automatically be
+    #             generated from the recipient group name or phone numbers.
+    #     
+    #     - status_url
+    #         * Webhook callback URL to be notified when message status changes
+    #     
+    #     - 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). Does not apply
+    #             when `message_type`=`service`, since the labels are determined by the service
+    #             itself.
+    #     
+    #     - exclude_contact_id
+    #         * Optionally excludes one contact from receiving the message (only when group_id is
+    #             set)
+    #     
+    #     - is_template (bool)
+    #         * Set to true to evaluate variables like [[contact.name]] in message content [(See
+    #             available variables)](#variables)
+    #         * Default: false
+    #     
+    #     - track_clicks (boolean)
+    #         * If true, URLs in the message content will automatically be replaced with unique
+    #             short URLs.
+    #         * Default: false
+    #     
+    #     - media_urls (array)
+    #         * URLs of media files to attach to the text message. If `message_type` is `sms`,
+    #             short links to each URL will be appended to the end of the content (separated by a
+    #             new line).
+    #     
+    #     - vars (Hash)
+    #         * Custom variables to set for each message
     #     
     #     - service_id
-    #         * Service that defines the call flow of the voice call (when `message_type` is
-    #             `call`)
+    #         * Service to invoke for each recipient (when `message_type` is `call` or `service`)
+    #         * Required if message_type is service
     #     
     #     - audio_url
     #         * The URL of an MP3 file to play when the contact answers the call (when
@@ -184,6 +235,51 @@ class Project < Entity
     #         * The name of the text-to-speech voice (when message_type=call)
     #         * Allowed values: female, male
     #         * Default: female
+    #   
+    # Returns:
+    #     Telerivet::Broadcast
+    #
+    def send_broadcast(options)
+        require_relative 'broadcast'
+        Broadcast.new(@api, @api.do_request("POST", get_base_api_path() + "/send_broadcast", options))
+    end
+
+    #
+    # Sends up to 100 different messages in a single API request. This method is significantly
+    # faster than sending a separate API request for each message.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - messages (array)
+    #         * Array of up to 100 objects with `content` and `to_number` properties. Each object
+    #             may also contain the optional properties `status_url`, `status_secret`, `vars`,
+    #             and/or `priority`, which override the parameters of the same name defined below, to
+    #             allow passing different values for each message.
+    #         * Required
+    #     
+    #     - message_type
+    #         * Type of message to send. If `text`, will use the default text message type for the
+    #             selected route.
+    #         * Allowed values: sms, mms, chat, text
+    #         * Default: text
+    #     
+    #     - route_id
+    #         * ID of the phone or route to send the messages from
+    #         * Default: default sender route ID
+    #     
+    #     - broadcast_id (string)
+    #         * ID of an existing broadcast to associate the messages with
+    #     
+    #     - broadcast_title (string)
+    #         * Title of broadcast to create (when `broadcast_id` is not provided).
+    #             When sending more than 100 messages over multiple API
+    #             requests, you can associate all messages with the same broadcast by providing a
+    #             `broadcast_title` parameter in the first
+    #             API request, then retrieving the `broadcast_id` property
+    #             from the API response, and passing it as the `broadcast_id` parameter in subsequent
+    #             API requests.
     #     
     #     - status_url
     #         * Webhook callback URL to be notified when message status changes
@@ -192,19 +288,71 @@ class Project < Entity
     #         * 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)
+    #         * Array of IDs of labels to add to each message (maximum 5)
     #     
     #     - is_template (bool)
     #         * Set to true to evaluate variables like [[contact.name]] in message content [(See
     #             available variables)](#variables)
     #         * Default: false
     #     
+    #     - media_urls (array)
+    #         * URLs of media files to attach to the text message. If `message_type` is `sms`,
+    #             short links to each media URL will be appended to the end of the content (separated
+    #             by a new line).
+    #     
     #     - vars (Hash)
-    #         * Custom variables to set for each message
+    #         * Custom variables to store with the message
+    #     
+    #     - priority (int)
+    #         * Priority of the message. Telerivet will attempt to send messages with higher
+    #             priority numbers first (for example, so you can prioritize an auto-reply ahead of a
+    #             bulk message to a large group).
+    #         * Allowed values: 1, 2
+    #         * Default: 1
+    #     
+    #     - simulated (bool)
+    #         * Set to true to test the Telerivet API without actually sending a message from the
+    #             route
+    #         * Default: false
+    #   
+    # Returns:
+    #     (associative array)
+    #       - messages (array)
+    #           * List of objects representing each newly created message, with the same length
+    #               and order as provided in the `messages` parameter in the API request.
+    #               Each object has the `id` and `status` properties,
+    #               and may have the property `error_message`.
+    #               (Other properties of the Message object are
+    #               omitted in order to reduce the amount of redundant data sent in each API
+    #               response.)
+    #       
+    #       - broadcast_id
+    #           * ID of broadcast that these messages are associated with, if `broadcast_id` or
+    #               `broadcast_title` parameter is provided in the API request.
+    #
+    def send_multi(options)
+        data = @api.do_request("POST", get_base_api_path() + "/send_multi", options)
+        return data
+    end
+
+    #
+    # (Deprecated) Send a message a to group or a list of phone numbers.
+    # This method is only needed to maintain backward compatibility with
+    # code developed using previous versions of the client library.
+    # Use `sendBroadcast` or `sendMulti` instead.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - message_type
+    #     
+    #     - content
+    #         * Required
+    #     
+    #     - group_id
+    #     
+    #     - to_numbers
     #   
     # Returns:
     #     (associative array)
@@ -212,8 +360,7 @@ class Project < Entity
     #           * Number of messages queued to send
     #       
     #       - broadcast_id
-    #           * ID of broadcast created for this message batch. If `count_queued` is 0 or 1, a
-    #               broadcast will not be created, and the `broadcast_id` property will be null.
+    #           * ID of broadcast created for this message batch.
     #
     def send_messages(options)
         data = @api.do_request("POST", get_base_api_path() + "/messages/send_batch", options)
@@ -225,13 +372,18 @@ class Project < Entity
     # messages approximately once every 15 seconds, so it is not possible to control the exact
     # second at which a scheduled message is sent.
     # 
+    # With `message_type`=`service`, schedules an automated service (such
+    # as a poll) to be invoked for a group or list of phone numbers. Any service that can be
+    # triggered for a contact can be scheduled via this method, whether or not the service
+    # actually sends a message.
+    # 
     # Arguments:
     #   - options (Hash)
     #       * Required
     #     
     #     - message_type
     #         * Type of message to send
-    #         * Allowed values: sms, ussd, call
+    #         * Allowed values: sms, ussd, call, service
     #         * Default: sms
     #     
     #     - content
@@ -262,11 +414,11 @@ class Project < Entity
     #     
     #     - route_id
     #         * ID of the phone or route to send the message from
-    #         * Default: default sender phone ID
+    #         * Default: default sender route ID
     #     
     #     - service_id
-    #         * Service that defines the call flow of the voice call (when `message_type` is
-    #             `call`)
+    #         * Service to invoke for each recipient (when `message_type` is `call` or `service`)
+    #         * Required if message_type is service
     #     
     #     - audio_url
     #         * The URL of an MP3 file to play when the contact answers the call (when
@@ -290,12 +442,24 @@ class Project < Entity
     #         * Allowed values: female, male
     #         * Default: female
     #     
+    #     - track_clicks (boolean)
+    #         * If true, URLs in the message content will automatically be replaced with unique
+    #             short URLs.
+    #         * Default: false
+    #     
     #     - is_template (bool)
     #         * Set to true to evaluate variables like [[contact.name]] in message content
     #         * Default: false
     #     
+    #     - media_urls (array)
+    #         * URLs of media files to attach to the text message. If `message_type` is `sms`,
+    #             short links to each media URL will be appended to the end of the content (separated
+    #             by a new line).
+    #     
     #     - label_ids (array)
-    #         * Array of IDs of labels to add to the sent messages (maximum 5)
+    #         * Array of IDs of labels to add to the sent messages (maximum 5). Does not apply
+    #             when `message_type`=`service`, since the labels are determined by the service
+    #             itself.
     #     
     #     - timezone_id
     #         * TZ database timezone ID; see
@@ -308,6 +472,10 @@ class Project < Entity
     #     
     #     - end_time_offset (int)
     #         * Number of seconds from now until the recurring message will stop
+    #     
+    #     - vars (Hash)
+    #         * Custom variables to set for this scheduled message, which will be copied to each
+    #             message sent from this scheduled message
     #   
     # Returns:
     #     Telerivet::ScheduledMessage
@@ -339,7 +507,7 @@ class Project < Entity
     #         * Required
     #     
     #     - phone_id
-    #         * ID of the phone that received the message
+    #         * ID of the phone (basic route) that received the message
     #         * Required
     #     
     #     - to_number
@@ -423,6 +591,57 @@ class Project < Entity
         Contact.new(@api, @api.do_request("POST", get_base_api_path() + "/contacts", options))
     end
 
+    #
+    # Creates and/or updates up to 200 contacts in a single API call. When creating or updating a
+    # large number of contacts, this method is significantly faster than sending a separate API
+    # request for each contact.
+    # 
+    # By default, if the phone number for any contact matches an existing
+    # contact, the existing contact will be updated with any information provided. This behavior
+    # can be modified by setting the `lookup_key` parameter to look up contacts by another field,
+    # including a custom variable.
+    # 
+    # If any contact was not found matching the provided `lookup_key`, a
+    # new contact will be created.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - contacts (array)
+    #         * Array of up to 200 objects which may contain the properties `name` (string),
+    #             `phone_number` (string), `vars` (object), and `send_blocked` (boolean). All
+    #             properties are optional, unless used as a lookup key; however, either a `name` or
+    #             `phone_number` property must be provided for new contacts.
+    #         * Required
+    #     
+    #     - 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, id, vars.variable_name, none
+    #         * Default: phone_number
+    #     
+    #     - add_group_ids (array)
+    #         * ID of one or more groups to add these contacts as members (max 5)
+    #     
+    #     - remove_group_ids (array)
+    #         * ID of one or more groups to remove these contacts as members (max 5)
+    #     
+    #     - default_route_id
+    #         * ID of the route to use by default to send messages to these contacts
+    #   
+    # Returns:
+    #     (associative array)
+    #       - contacts (array)
+    #           * List of objects representing each contact, with the same length and order as
+    #               provided in the `contacts` parameter in the API request. Each object has a string
+    #               `id` property.
+    #
+    def import_contacts(options)
+        data = @api.do_request("POST", get_base_api_path() + "/import_contacts", options)
+        return data
+    end
+
     #
     # Queries contacts within the given project.
     # 
@@ -491,7 +710,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -571,7 +790,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -630,11 +849,12 @@ class Project < Entity
     #     
     #     - message_type
     #         * Filter messages by message_type
-    #         * Allowed values: sms, mms, ussd, call
+    #         * Allowed values: sms, mms, ussd, call, 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
@@ -657,7 +877,13 @@ class Project < Entity
     #         * ID of the contact who sent/received the message
     #     
     #     - phone_id
-    #         * ID of the phone that sent/received the message
+    #         * ID of the phone (basic route) that sent/received the message
+    #     
+    #     - broadcast_id
+    #         * ID of the broadcast containing the message
+    #     
+    #     - scheduled_id
+    #         * ID of the scheduled message that created this message
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -670,7 +896,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -746,7 +972,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -818,7 +1044,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -903,7 +1129,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -988,7 +1214,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -1059,7 +1285,7 @@ class Project < Entity
     #     
     #     - message_type
     #         * Filter scheduled messages by message_type
-    #         * Allowed values: sms, mms, ussd, call
+    #         * Allowed values: sms, mms, ussd, call, service
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter scheduled messages by time_created
@@ -1081,7 +1307,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -1157,7 +1383,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -1205,37 +1431,19 @@ class Project < Entity
     end
 
     #
-    # Queries mobile money receipts within the given project.
+    # Queries custom routes that can be used to send messages (not including Phones).
     # 
     # Arguments:
     #   - options (Hash)
     #     
-    #     - tx_id
-    #         * Filter receipts by transaction ID
-    #     
-    #     - tx_type
-    #         * Filter receipts by transaction type
-    #         * Allowed values: receive_money, send_money, pay_bill, deposit, withdrawal,
-    #             airtime_purchase, balance_inquiry, reversal
-    #     
-    #     - tx_time (UNIX timestamp)
-    #         * Filter receipts by transaction time
-    #         * Allowed modifiers: tx_time[ne], tx_time[min], tx_time[max]
-    #     
     #     - name
-    #         * Filter receipts by other person's name
+    #         * Filter routes by name
     #         * Allowed modifiers: name[ne], name[prefix], name[not_prefix], name[gte], name[gt],
     #             name[lt], name[lte]
     #     
-    #     - phone_number
-    #         * Filter receipts by other person's 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]
-    #     
     #     - sort
     #         * Sort the results based on a field
-    #         * Allowed values: default
+    #         * Allowed values: default, name
     #         * Default: default
     #     
     #     - sort_dir
@@ -1244,7 +1452,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -1252,60 +1460,82 @@ class Project < Entity
     #         * Default: 0
     #   
     # Returns:
-    #     Telerivet::APICursor (of Telerivet::MobileMoneyReceipt)
+    #     Telerivet::APICursor (of Telerivet::Route)
     #
-    def query_receipts(options = nil)
-        require_relative 'mobilemoneyreceipt'
-        @api.cursor(MobileMoneyReceipt, get_base_api_path() + "/receipts", options)
+    def query_routes(options = nil)
+        require_relative 'route'
+        @api.cursor(Route, get_base_api_path() + "/routes", options)
     end
 
     #
-    # Retrieves the mobile money receipt with the given ID.
+    # Gets a custom route by ID
     # 
     # Arguments:
     #   - id
-    #       * ID of the mobile money receipt
+    #       * ID of the route
     #       * Required
     #   
     # Returns:
-    #     Telerivet::MobileMoneyReceipt
+    #     Telerivet::Route
     #
-    def get_receipt_by_id(id)
-        require_relative 'mobilemoneyreceipt'
-        MobileMoneyReceipt.new(@api, @api.do_request("GET", get_base_api_path() + "/receipts/#{id}"))
+    def get_route_by_id(id)
+        require_relative 'route'
+        Route.new(@api, @api.do_request("GET", get_base_api_path() + "/routes/#{id}"))
     end
 
     #
-    # Initializes the mobile money receipt with the given ID without making an API request.
+    # Initializes a custom route by ID without making an API request.
     # 
     # Arguments:
     #   - id
-    #       * ID of the mobile money receipt
+    #       * ID of the route
     #       * Required
     #   
     # Returns:
-    #     Telerivet::MobileMoneyReceipt
+    #     Telerivet::Route
     #
-    def init_receipt_by_id(id)
-        require_relative 'mobilemoneyreceipt'
-        return MobileMoneyReceipt.new(@api, {'project_id' => self.id, 'id' => id}, false)
+    def init_route_by_id(id)
+        require_relative 'route'
+        return Route.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
 
     #
-    # Queries custom routes that can be used to send messages (not including Phones).
+    # 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
+
+    #
+    # Returns information about each airtime transaction.
     # 
     # Arguments:
     #   - options (Hash)
     #     
-    #     - name
-    #         * Filter routes by name
-    #         * Allowed modifiers: name[ne], name[prefix], name[not_prefix], name[gte], name[gt],
-    #             name[lt], name[lte]
+    #     - time_created[min] (UNIX timestamp)
+    #         * Filter transactions created on or after a particular time
     #     
-    #     - sort
-    #         * Sort the results based on a field
-    #         * Allowed values: default, name
-    #         * Default: default
+    #     - time_created[max] (UNIX timestamp)
+    #         * Filter transactions created before a particular time
+    #     
+    #     - contact_id
+    #         * Filter transactions sent to a particular contact
+    #     
+    #     - to_number
+    #         * Filter transactions sent to a particular phone number
+    #     
+    #     - service_id
+    #         * Filter transactions sent by a particular service
+    #     
+    #     - status
+    #         * Filter transactions by status
+    #         * Allowed values: pending, queued, processing, successful, failed, cancelled,
+    #             pending_payment, pending_approval
     #     
     #     - sort_dir
     #         * Sort the results in ascending or descending order
@@ -1313,7 +1543,7 @@ class Project < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -1321,55 +1551,43 @@ class Project < Entity
     #         * Default: 0
     #   
     # Returns:
-    #     Telerivet::APICursor (of Telerivet::Route)
+    #     Telerivet::APICursor (of Telerivet::AirtimeTransaction)
     #
-    def query_routes(options = nil)
-        require_relative 'route'
-        @api.cursor(Route, get_base_api_path() + "/routes", options)
+    def query_airtime_transactions(options = nil)
+        require_relative 'airtimetransaction'
+        @api.cursor(AirtimeTransaction, get_base_api_path() + "/airtime_transactions", options)
     end
 
     #
-    # Gets a custom route by ID
+    # Gets an airtime transaction by ID
     # 
     # Arguments:
     #   - id
-    #       * ID of the route
+    #       * ID of the airtime transaction
     #       * Required
     #   
     # Returns:
-    #     Telerivet::Route
+    #     Telerivet::AirtimeTransaction
     #
-    def get_route_by_id(id)
-        require_relative 'route'
-        Route.new(@api, @api.do_request("GET", get_base_api_path() + "/routes/#{id}"))
+    def get_airtime_transaction_by_id(id)
+        require_relative 'airtimetransaction'
+        AirtimeTransaction.new(@api, @api.do_request("GET", get_base_api_path() + "/airtime_transactions/#{id}"))
     end
 
     #
-    # Initializes a custom route by ID without making an API request.
+    # Initializes an airtime transaction by ID without making an API request.
     # 
     # Arguments:
     #   - id
-    #       * ID of the route
+    #       * ID of the airtime transaction
     #       * Required
     #   
     # Returns:
-    #     Telerivet::Route
-    #
-    def init_route_by_id(id)
-        require_relative 'route'
-        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
+    #     Telerivet::AirtimeTransaction
     #
-    def get_users()
-        return @api.do_request("GET", get_base_api_path() + "/users")
+    def init_airtime_transaction_by_id(id)
+        require_relative 'airtimetransaction'
+        return AirtimeTransaction.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
 
     #