telerivet 1.8.2 → 1.8.5

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)
@@ -34,10 +31,15 @@ module Telerivet
 #   - 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
@@ -59,6 +61,14 @@ class Route < Entity
         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

@@ -169,6 +169,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
     #
@@ -365,6 +370,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

@@ -61,12 +61,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 +122,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 +149,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 +170,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 +344,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) for available configuration
+    # options.
     # 
     # Returns:
     #     object
@@ -333,8 +365,8 @@ 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) for available configuration options.
     #       * Required
     #   
     # Returns:
@@ -414,6 +446,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 +514,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/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

data/lib/telerivet/webhook.rb

@@ -0,0 +1,98 @@
+
+module Telerivet
+
+#
+# Represents a webhook that is triggered when specific events occur within a project.
+# 
+# Webhooks allow your server to receive HTTP POST requests when certain events
+# happen, such as when a message's status changes or when a contact is updated.
+# 
+# When an event occurs that matches a webhook's event types, Telerivet will
+# send an HTTP POST request to the webhook URL with information about the event. For more
+# information about the webhook request format, see the [Webhook API](/api/webhook)
+# documentation.
+# 
+# Note: The Webhook object is not used for notifying your server when incoming
+# messages are received. To notify a URL when incoming messages are received, you can
+# configure a webhook by [creating a Service](#Project.createService) with type
+# incoming_message_webhook.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the webhook
+#       * Read-only
+#   
+#   - url
+#       * URL that webhook requests are sent to
+#       * Updatable via API
+#   
+#   - secret
+#       * Secret included with webhook requests for authentication (sent as HTTP basic auth
+#           password with username 'telerivet')
+#       * Updatable via API
+#   
+#   - events (array of strings)
+#       * Array of event types that trigger this webhook. Possible values: `send_status`
+#           (message status updates), `send_broadcast` (broadcast sent), `contact_update` (contact
+#           added/updated/deleted), `message_metadata` (message metadata updated)
+#       * Updatable via API
+#   
+#   - project_id
+#       * ID of the project this webhook belongs to
+#       * Read-only
+#
+class Webhook < Entity
+    #
+    # Saves any fields that have changed for this webhook.
+    #
+    def save()
+        super
+    end
+
+    #
+    # Deletes the webhook.
+    #
+    def delete()
+        @api.do_request("DELETE", get_base_api_path())
+    end
+
+    def id
+        get('id')
+    end
+
+    def url
+        get('url')
+    end
+
+    def url=(value)
+        set('url', value)
+    end
+
+    def secret
+        get('secret')
+    end
+
+    def secret=(value)
+        set('secret', value)
+    end
+
+    def events
+        get('events')
+    end
+
+    def events=(value)
+        set('events', value)
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/webhooks/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet.rb

@@ -9,7 +9,7 @@ module Telerivet
 class API
     attr_reader :num_requests
 
-    @@client_version = '1.8.2'
+    @@client_version = '1.8.5'
 
     #
     # Initializes a client handle to the Telerivet REST API.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerivet
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.5
 platform: ruby
 authors:
 - Jesse Young
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-09 00:00:00.000000000 Z
+date: 2026-01-27 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com
@@ -28,14 +28,17 @@ files:
 - lib/telerivet/group.rb
 - lib/telerivet/label.rb
 - lib/telerivet/message.rb
+- lib/telerivet/messagetemplate.rb
 - lib/telerivet/organization.rb
 - lib/telerivet/phone.rb
 - lib/telerivet/project.rb
 - lib/telerivet/relativescheduledmessage.rb
 - lib/telerivet/route.rb
 - lib/telerivet/scheduledmessage.rb
+- lib/telerivet/scheduledservice.rb
 - lib/telerivet/service.rb
 - lib/telerivet/task.rb
+- lib/telerivet/webhook.rb
 homepage: http://telerivet.com
 licenses:
 - MIT