telerivet 1.4.2 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a8d93278a1028f9ff5744fa1eebb37b9e57f2883
-  data.tar.gz: 95865ab958259080cadebf2fc7351e0d0ce5563a
+SHA256:
+  metadata.gz: 0633af0317a3ef409a86481a483f934d2832d2f6a11fd545221997c3ebb495ad
+  data.tar.gz: 344a694d8cc84a5231cefa14d26f89fceecf6d140f201e013705794684f94015
 SHA512:
-  metadata.gz: 364d571be0d300d075acd89004956619270bcf95b676e5dc6694f97a6e95f2a5143348213f22ce2d77e4355aad8c95539f360d795562996c601160b709929f9f
-  data.tar.gz: 3b19fcd0e413b8e4e4f2199ecba6ad424031a038e22cc169403b32a60c8e4e717230cb2fc8eb4ea188237cc4eaa5e6c23fdd1b742d3b57ae16e5958defb8ed5b
+  metadata.gz: 74a877df3a572e3b1d96922343d0bc54ed58a2f2d28b36bf883691a3b440244e777cdb74cfed10f701a2f8a768dd157e5ada0f116b1c588774744080699fabc8
+  data.tar.gz: b75d13f319943c2f899200a1845932aad01205a902b280c2128d8bf19c7453b696386a539c278df2a1a19cba14c018189a817a622f2897d229b63eba3f94b7f3

data/lib/telerivet.rb

@@ -9,7 +9,7 @@ module Telerivet
 class API
     attr_reader :num_requests
 
-    @@client_version = '1.4.2'
+    @@client_version = '1.4.5'
 
     #
     # Initializes a client handle to the Telerivet REST API.
@@ -153,7 +153,7 @@ class API
     #         * 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)
@@ -222,7 +222,7 @@ class API
     #         * 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/broadcast.rb

@@ -75,7 +75,7 @@ module Telerivet
 #   
 #   - message_type
 #       * Type of message sent from this broadcast
-#       * Allowed values: sms, mms, ussd, call
+#       * Allowed values: sms, mms, ussd, call, service
 #       * Read-only
 #   
 #   - content (string)
@@ -117,10 +117,29 @@ module Telerivet
 #           sent to or received by a real phone)
 #       * Read-only
 #   
+#   - track_clicks (boolean)
+#       * If true, URLs in the message content will automatically be replaced with unique
+#           short URLs.
+#       * Read-only
+#   
+#   - clicked_count (int)
+#       * The number of messages in this broadcast containing short links that were clicked.
+#           At most one click per message is counted. If track_clicks is false, this property will
+#           be null.
+#       * Read-only
+#   
 #   - label_ids (array)
 #       * List of IDs of labels applied to all messages in the broadcast
 #       * 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
+#   
 #   - vars (Hash)
 #       * Custom variables stored for this broadcast
 #       * Read-only
@@ -147,6 +166,11 @@ module Telerivet
 #       * ID of the phone or route used to send the broadcast (if applicable)
 #       * Read-only
 #   
+#   - service_id (string, max 34 characters)
+#       * The service associated with this broadcast (for voice calls, the service defines the
+#           call flow)
+#       * Read-only
+#   
 #   - user_id (string, max 34 characters)
 #       * ID of the Telerivet user who sent the broadcast (if applicable)
 #       * Read-only
@@ -242,10 +266,22 @@ class Broadcast < Entity
         get('simulated')
     end
 
+    def track_clicks
+        get('track_clicks')
+    end
+
+    def clicked_count
+        get('clicked_count')
+    end
+
     def label_ids
         get('label_ids')
     end
 
+    def media
+        get('media')
+    end
+
     def price
         get('price')
     end
@@ -266,6 +302,10 @@ class Broadcast < Entity
         get('route_id')
     end
 
+    def service_id
+        get('service_id')
+    end
+
     def user_id
         get('user_id')
     end

data/lib/telerivet/contact.rb

@@ -19,6 +19,10 @@ module Telerivet
 #       * Time the contact was added in Telerivet
 #       * Read-only
 #   
+#   - time_updated (UNIX timestamp)
+#       * Time the contact was last updated in Telerivet
+#       * Read-only
+#   
 #   - send_blocked (bool)
 #       * True if Telerivet is blocked from sending messages to this contact
 #       * Updatable via API
@@ -125,7 +129,7 @@ class Contact < 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
@@ -157,6 +161,9 @@ class Contact < Entity
     #     - 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
     #         * Allowed values: default
@@ -168,7 +175,7 @@ class Contact < 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)
@@ -208,7 +215,7 @@ class Contact < 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)
@@ -232,7 +239,7 @@ class Contact < 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
@@ -254,7 +261,7 @@ class Contact < 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)
@@ -290,7 +297,7 @@ class Contact < 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)
@@ -333,7 +340,7 @@ class Contact < 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)
@@ -386,6 +393,10 @@ class Contact < Entity
         get('time_created')
     end
 
+    def time_updated
+        get('time_updated')
+    end
+
     def send_blocked
         get('send_blocked')
     end

data/lib/telerivet/datatable.rb

@@ -76,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)
@@ -175,7 +175,7 @@ class DataTable < Entity
     #     - type (string)
     #         * Field type
     #         * Allowed values: text, long_text, number, boolean, email, url, audio, phone_number,
-    #             date, date_time, groups, route
+    #             date, date_time, groups, route, select, buttons
     #     
     #     - order (int)
     #         * Order in which to display the field

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,7 +39,7 @@ 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
@@ -71,6 +71,9 @@ class Label < Entity
     #     - 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
     #         * Allowed values: default
@@ -82,7 +85,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,7 +23,7 @@ module Telerivet
 #   
 #   - message_type
 #       * Type of the message
-#       * Allowed values: sms, mms, ussd, call
+#       * Allowed values: sms, mms, ussd, call, service
 #       * Read-only
 #   
 #   - source
@@ -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,6 +131,35 @@ 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)
@@ -143,6 +181,10 @@ module Telerivet
 #       * 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

@@ -111,7 +111,7 @@ 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
@@ -143,6 +143,9 @@ class Phone < Entity
     #     - 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
     #         * Allowed values: default
@@ -154,7 +157,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
@@ -65,6 +66,45 @@ class Project < Entity
     #         * ID of the phone or route to send the message from
     #         * 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
     #             `call`)
@@ -90,29 +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
     #   
     # Returns:
     #     Telerivet::Message
@@ -124,16 +141,21 @@ class Project < Entity
 
     #
     # Sends a text message (optionally with mail-merge templates) or voice call to a group or a
-    # list of up to 500 phone numbers
+    # 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
@@ -155,9 +177,42 @@ class Project < Entity
     #         * 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
@@ -180,27 +235,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
-    #     
-    #     - 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)
-    #     
-    #     - is_template (bool)
-    #         * Set to true to evaluate variables like [[contact.name]] in message content [(See
-    #             available variables)](#variables)
-    #         * Default: false
-    #     
-    #     - vars (Hash)
-    #         * Custom variables to set for each message
     #   
     # Returns:
     #     Telerivet::Broadcast
@@ -219,13 +253,17 @@ class Project < Entity
     #       * Required
     #     
     #     - messages (array)
-    #         * Array of up to 100 objects with `content` and `to_number` properties
+    #         * 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
-    #         * Allowed values: sms
-    #         * Default: sms
+    #         * 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
@@ -256,6 +294,26 @@ class Project < Entity
     #         * 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 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)
@@ -314,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
@@ -354,8 +417,8 @@ class Project < Entity
     #         * 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
@@ -379,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
@@ -397,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
@@ -631,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)
@@ -711,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)
@@ -770,7 +849,7 @@ 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
@@ -802,6 +881,9 @@ class Project < Entity
     #     - 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
     #         * Allowed values: default
@@ -813,7 +895,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)
@@ -889,7 +971,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)
@@ -961,7 +1043,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)
@@ -1046,7 +1128,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)
@@ -1131,7 +1213,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)
@@ -1202,7 +1284,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
@@ -1224,7 +1306,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)
@@ -1300,7 +1382,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)
@@ -1369,7 +1451,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)

data/lib/telerivet/scheduledmessage.rb

@@ -87,7 +87,7 @@ module Telerivet
 #   
 #   - message_type
 #       * Type of scheduled message
-#       * Allowed values: sms, ussd, call
+#       * Allowed values: sms, mms, ussd, call, service
 #       * Read-only
 #   
 #   - time_created (UNIX timestamp)
@@ -122,6 +122,19 @@ module Telerivet
 #           content, false otherwise
 #       * Read-only
 #   
+#   - track_clicks (boolean)
+#       * If true, URLs in the message content will automatically be replaced with unique
+#           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
+#   
 #   - vars (Hash)
 #       * Custom variables stored for this scheduled message (copied to Message when sent)
 #       * Updatable via API
@@ -237,6 +250,14 @@ class ScheduledMessage < Entity
         get('is_template')
     end
 
+    def track_clicks
+        get('track_clicks')
+    end
+
+    def media
+        get('media')
+    end
+
     def label_ids
         get('label_ids')
     end

data/lib/telerivet/service.rb

@@ -82,7 +82,9 @@ class Service < Entity
     # 
     # For example, to send a poll to a particular contact (or resend the
     # current question), you can invoke the poll service with context=contact, and `contact_id` as
-    # the ID of the contact to send the poll to.
+    # the ID of the contact to send the poll to. (To trigger a service to multiple contacts, use
+    # [project.sendBroadcast](#Project.sendBroadcast). To schedule a service in the future, use
+    # [project.scheduleMessage](#Project.scheduleMessage).)
     # 
     # Or, to manually apply a service for an incoming message, you can
     # invoke the service with `context`=`message`, `event`=`incoming_message`, and `message_id` as
@@ -223,7 +225,7 @@ class Service < 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerivet
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.5
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2019-11-15 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com
@@ -53,8 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Telerivet REST API Client