telerivet 1.8.2 → 1.9.6

data/lib/telerivet/relativescheduledmessage.rb

@@ -36,10 +36,10 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - offset_scale
-#       * The type of interval (day/week/month/year) that will be used to adjust the scheduled
-#           date relative to the date stored in the contact's date_variable, when offset_count is
-#           non-zero (D=day, W=week, M=month, Y=year)
-#       * Allowed values: D, W, M, Y
+#       * The type of interval that will be used to adjust the scheduled date relative to the
+#           date stored in the contact's date_variable, when offset_count is non-zero (I=minutes,
+#           D=day, W=week, M=month, Y=year)
+#       * Allowed values: I, D, W, M, Y
 #       * Updatable via API
 #   
 #   - offset_count (int)
@@ -126,12 +126,9 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - 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
+#       * Array of media attachments for the text message. This property is undefined for
+#           messages that do not contain media files.
+#       * Updatable via API
 #   
 #   - route_params (Hash)
 #       * Route-specific parameters to use when sending the message.
@@ -340,6 +337,10 @@ class RelativeScheduledMessage < Entity
         get('media')
     end
 
+    def media=(value)
+        set('media', value)
+    end
+
     def route_params
         get('route_params')
     end

data/lib/telerivet/route.rb

@@ -9,9 +9,6 @@ module Telerivet
 # parameters, and properties related to Custom Routes continue to use the term "Route" to
 # maintain backwards compatibility.
 # 
-# Custom routing rules can currently only be configured via Telerivet's web
-# UI.
-# 
 # Fields:
 # 
 #   - id (string, max 34 characters)
@@ -31,13 +28,22 @@ module Telerivet
 #           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
+#   - url
+#       * URL to this route in the Telerivet web app
+#       * Read-only
+#   
 #   - project_id
 #       * ID of the project this route belongs to
 #       * Read-only
+#   
+#   - actions (array of RoutingAction)
+#       * Array of routing action objects. Allowed action types: `use_phone`, `condition`.
+#       * Updatable via API
 #
 class Route < Entity
     #
-    # Saves any fields or custom variables that have changed for this custom route.
+    # Saves any fields, custom variables, or routing actions that have changed for this custom
+    # route.
     #
     def save()
         super
@@ -55,10 +61,22 @@ class Route < Entity
         set('name', value)
     end
 
+    def url
+        get('url')
+    end
+
     def project_id
         get('project_id')
     end
 
+    def actions
+        get('actions')
+    end
+
+    def actions=(value)
+        set('actions', value)
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/routes/#{get('id')}"
     end

data/lib/telerivet/scheduledmessage.rb

@@ -130,12 +130,9 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - 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
+#       * Array of media attachments for the text message. This property is undefined for
+#           messages that do not contain media files.
+#       * Updatable via API
 #   
 #   - route_params (Hash)
 #       * Route-specific parameters to use when sending the message.
@@ -169,6 +166,11 @@ module Telerivet
 #   - project_id
 #       * ID of the project this scheduled message belongs to
 #       * Read-only
+#   
+#   - is_template (bool)
+#       * Set to true if Telerivet will render variables like [[contact.name]] in the message
+#           content
+#       * Read-only
 #
 class ScheduledMessage < Entity
     #
@@ -341,6 +343,10 @@ class ScheduledMessage < Entity
         get('media')
     end
 
+    def media=(value)
+        set('media', value)
+    end
+
     def route_params
         get('route_params')
     end
@@ -365,6 +371,10 @@ class ScheduledMessage < Entity
         get('project_id')
     end
 
+    def is_template
+        get('is_template')
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/scheduled/#{get('id')}"
     end

data/lib/telerivet/scheduledservice.rb

@@ -0,0 +1,160 @@
+
+module Telerivet
+
+#
+# Represents a scheduled service within Telerivet.
+# 
+# Scheduled services allow services to be triggered automatically at specified
+# times.
+# The ScheduledService object is only used for services that are triggered for
+# a project (e.g. `scheduled_actions` or `scheduled_script`).
+# 
+# Note: To schedule services that are triggered for a contact, the
+# [ScheduledMessage](#ScheduledMessage) object should be used instead, with
+# `message_type`=`service`.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the scheduled service
+#       * Read-only
+#   
+#   - service_id (string, max 34 characters)
+#       * ID of the service to be triggered
+#       * Read-only
+#   
+#   - rrule
+#       * Recurrence rule for recurring scheduled services, e.g. 'FREQ=MONTHLY' or
+#           'FREQ=WEEKLY;INTERVAL=2'; see
+#           [RFC2445](https://tools.ietf.org/html/rfc2445#section-4.3.10).
+#       * Updatable via API
+#   
+#   - timezone_id
+#       * Timezone ID used to compute times for recurring scheduled services; see [List of tz
+#           database time zones Wikipedia
+#           article](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+#       * Updatable via API
+#   
+#   - time_created (UNIX timestamp)
+#       * Time the scheduled service was created in Telerivet
+#       * Read-only
+#   
+#   - start_time (UNIX timestamp)
+#       * The time that the service will be triggered (or first triggered for recurring
+#           scheduled services)
+#       * Updatable via API
+#   
+#   - end_time (UNIX timestamp)
+#       * Time after which a recurring scheduled service will stop (not applicable to
+#           non-recurring scheduled services)
+#       * Updatable via API
+#   
+#   - prev_time (UNIX timestamp)
+#       * The most recent time that Telerivet triggered this scheduled service (null if it has
+#           never been triggered)
+#       * Read-only
+#   
+#   - next_time (UNIX timestamp)
+#       * The next upcoming time that Telerivet will trigger this scheduled service (null if
+#           it will not be triggered again)
+#       * Read-only
+#   
+#   - occurrences (int)
+#       * Number of times this scheduled service has already been triggered
+#       * Read-only
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this scheduled service. 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
+#       * ID of the project this scheduled service belongs to
+#       * Read-only
+#
+class ScheduledService < Entity
+    #
+    # Saves any fields or custom variables that have changed for this scheduled service.
+    #
+    def save()
+        super
+    end
+
+    #
+    # Cancels this scheduled service.
+    #
+    def delete()
+        @api.do_request("DELETE", get_base_api_path())
+    end
+
+    def id
+        get('id')
+    end
+
+    def service_id
+        get('service_id')
+    end
+
+    def rrule
+        get('rrule')
+    end
+
+    def rrule=(value)
+        set('rrule', value)
+    end
+
+    def timezone_id
+        get('timezone_id')
+    end
+
+    def timezone_id=(value)
+        set('timezone_id', value)
+    end
+
+    def time_created
+        get('time_created')
+    end
+
+    def start_time
+        get('start_time')
+    end
+
+    def start_time=(value)
+        set('start_time', value)
+    end
+
+    def end_time
+        get('end_time')
+    end
+
+    def end_time=(value)
+        set('end_time', value)
+    end
+
+    def prev_time
+        get('prev_time')
+    end
+
+    def next_time
+        get('next_time')
+    end
+
+    def occurrences
+        get('occurrences')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/scheduled_services/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet/service.rb

@@ -53,6 +53,14 @@ module Telerivet
 #           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
+#   - url
+#       * URL to this service in the Telerivet web app
+#       * Read-only
+#   
+#   - url_edit
+#       * URL to edit the service in the Telerivet web app
+#       * Read-only
+#   
 #   - project_id
 #       * ID of the project this service belongs to
 #       * Read-only
@@ -61,12 +69,34 @@ module Telerivet
 #       * ID of the data table where responses to this service will be stored
 #       * Updatable via API
 #   
-#   - phone_ids
+#   - phone_ids (array)
 #       * IDs of phones (basic routes) associated with this service, or null if the service is
 #           associated with all routes. Only applies for service types that handle incoming
 #           messages, voice calls, or USSD sessions.
 #       * Updatable via API
 #   
+#   - message_types (array of strings)
+#       * Types of messages that this service handles. Only provided for service types that
+#           handle incoming messages.
+#       * Allowed values: text, call, ussd
+#       * Updatable via API
+#   
+#   - table_ids (array)
+#       * IDs of data tables that this service applies to, or null if this service applies to
+#           all data tables. Only provided for data row services (`data_row_script` and
+#           `data_row_actions`).
+#       * Updatable via API
+#   
+#   - message_statuses (array of strings)
+#       * Message statuses that this service handles. Only provided for
+#           `message_status_actions` services.
+#       * Allowed values: sent, delivered, failed, failed_queued, not_delivered
+#       * Updatable via API
+#   
+#   - tags (array)
+#       * Tags used to organize this service. Each tag can be up to 32 characters in length.
+#       * Updatable via API
+#   
 #   - apply_mode
 #       * If apply_mode is `unhandled`, the service will not be triggered if another service
 #           has already handled the incoming message. If apply_mode is `always`, the service will
@@ -100,6 +130,10 @@ module Telerivet
 #       * URL that a third-party can invoke to trigger this service. Only provided for
 #           services that are triggered by a webhook request.
 #       * Read-only
+#   
+#   - is_custom_template (bool)
+#       * Whether this service was created from a custom service template
+#       * Read-only
 #
 class Service < Entity
 
@@ -123,7 +157,8 @@ class Service < Entity
     #     
     #     - context
     #         * The name of the context in which this service is invoked
-    #         * Allowed values: message, call, ussd_session, row, contact, project
+    #         * Allowed values: message, call, ussd_session, row, contact, project,
+    #             airtime_transaction
     #         * Required
     #     
     #     - event
@@ -143,6 +178,10 @@ class Service < Entity
     #             or `phone_number` is required if `context` is 'contact'). If no  contact exists with
     #             this phone number, a new contact will be created.
     #     
+    #     - row_id
+    #         * The ID of the data row this service is triggered for
+    #         * Required if context is 'row'
+    #     
     #     - variables (Hash)
     #         * Object containing up to 25 temporary variable names and their corresponding values
     #             to set when invoking the service. Values may be strings, numbers, or boolean
@@ -313,7 +352,8 @@ class Service < Entity
     # Gets configuration specific to the type of automated service.
     # 
     # Only certain types of services provide their configuration via the
-    # API.
+    # API. See [Service Configuration Reference](#service_config) or the machine-readable [OpenAPI
+    # specification](https://api.telerivet.com/openapi.json) for available configuration options.
     # 
     # Returns:
     #     object
@@ -333,8 +373,10 @@ class Service < Entity
     # 
     # Arguments:
     #   - options (Hash)
-    #       * Configuration for this service type. See
-    #           [project.createService](#Project.createService) for available configuration options.
+    #       * Configuration for this service type. See [Service Configuration
+    #           Reference](#service_config) or the machine-readable [OpenAPI
+    #           specification](https://api.telerivet.com/openapi.json) for available configuration
+    #           options.
     #       * Required
     #   
     # Returns:
@@ -394,6 +436,14 @@ class Service < Entity
         get('contexts')
     end
 
+    def url
+        get('url')
+    end
+
+    def url_edit
+        get('url_edit')
+    end
+
     def project_id
         get('project_id')
     end
@@ -414,6 +464,38 @@ class Service < Entity
         set('phone_ids', value)
     end
 
+    def message_types
+        get('message_types')
+    end
+
+    def message_types=(value)
+        set('message_types', value)
+    end
+
+    def table_ids
+        get('table_ids')
+    end
+
+    def table_ids=(value)
+        set('table_ids', value)
+    end
+
+    def message_statuses
+        get('message_statuses')
+    end
+
+    def message_statuses=(value)
+        set('message_statuses', value)
+    end
+
+    def tags
+        get('tags')
+    end
+
+    def tags=(value)
+        set('tags', value)
+    end
+
     def apply_mode
         get('apply_mode')
     end
@@ -450,6 +532,10 @@ class Service < Entity
         get('webhook_url')
     end
 
+    def is_custom_template
+        get('is_custom_template')
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/services/#{get('id')}"
     end

data/lib/telerivet/storedfile.rb

@@ -0,0 +1,167 @@
+
+module Telerivet
+
+#
+# Represents a file stored in a Telerivet project, such as a media attachment for outgoing
+# messages.
+# 
+# Stored files are also automatically created for media attachments for
+# incoming messages.
+# 
+# Files can be uploaded via [project.uploadFile](#Project.uploadFile), then
+# attached to outgoing messages by passing the file ID as a `file_id` item in the `media`
+# parameter when sending a message or broadcast.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the stored file
+#       * Read-only
+#   
+#   - filename (string, max 127 characters)
+#       * Filename of the stored file
+#       * Updatable via API
+#   
+#   - type
+#       * MIME type of the file
+#       * Read-only
+#   
+#   - size (int)
+#       * Size of the file in bytes
+#       * Read-only
+#   
+#   - description (string, max 1000 characters)
+#       * Description of the file
+#       * Updatable via API
+#   
+#   - category
+#       * Category of the stored file
+#       * Allowed values: outgoing_media, incoming_media, call_audio, test_recording,
+#           script_module, icon
+#       * Read-only
+#   
+#   - source
+#       * How the stored file was created
+#       * Allowed values: upload, recording, message, api
+#       * Read-only
+#   
+#   - message_id
+#       * ID of the message associated with this file, if any. Files associated with a message
+#           are deleted automatically when the message is deleted.
+#       * Read-only
+#   
+#   - sha256
+#       * SHA-256 hash of the file content (lowercase hex), if available
+#       * Read-only
+#   
+#   - time_created (UNIX timestamp)
+#       * Time the file was created in Telerivet
+#       * Read-only
+#   
+#   - user_id (string, max 34 characters)
+#       * ID of the Telerivet user who created the file (if applicable)
+#       * Read-only
+#   
+#   - url
+#       * URL where the file content can be downloaded. Note: this URL is temporary and may
+#           not be valid for more than 1 day; retrieve the stored file again to get a fresh URL.
+#       * Read-only
+#   
+#   - thumbnail_url
+#       * URL of a thumbnail image for video files, if available. Note: this URL is temporary
+#           and may not be valid for more than 1 day.
+#       * Read-only
+#   
+#   - project_id
+#       * ID of the project this file belongs to
+#       * Read-only
+#
+class StoredFile < Entity
+    #
+    # Saves any fields that have changed for this stored file.
+    #
+    def save()
+        super
+    end
+
+    #
+    # Deletes this stored file.
+    # 
+    # A stored file may only be deleted by the user who created it or by a
+    # project administrator, and may not be deleted while it is attached to an existing message.
+    #
+    def delete()
+        @api.do_request("DELETE", get_base_api_path())
+    end
+
+    def id
+        get('id')
+    end
+
+    def filename
+        get('filename')
+    end
+
+    def filename=(value)
+        set('filename', value)
+    end
+
+    def type
+        get('type')
+    end
+
+    def size
+        get('size')
+    end
+
+    def description
+        get('description')
+    end
+
+    def description=(value)
+        set('description', value)
+    end
+
+    def category
+        get('category')
+    end
+
+    def source
+        get('source')
+    end
+
+    def message_id
+        get('message_id')
+    end
+
+    def sha256
+        get('sha256')
+    end
+
+    def time_created
+        get('time_created')
+    end
+
+    def user_id
+        get('user_id')
+    end
+
+    def url
+        get('url')
+    end
+
+    def thumbnail_url
+        get('thumbnail_url')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/files/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet/task.rb

@@ -58,6 +58,10 @@ module Telerivet
 #       * Allowed values: created, queued, active, complete, failed, cancelled
 #       * Read-only
 #   
+#   - error_message (string)
+#       * Error message if the task failed
+#       * Read-only
+#   
 #   - vars (Hash)
 #       * Custom variables stored for this task. Variable names may be up to 32 characters in
 #           length and can contain the characters a-z, A-Z, 0-9, and _.
@@ -135,6 +139,10 @@ class Task < Entity
         get('status')
     end
 
+    def error_message
+        get('error_message')
+    end
+
     def table_id
         get('table_id')
     end