telerivet 1.4.5 → 1.7.0

data/lib/telerivet/service.rb

@@ -21,6 +21,10 @@ module Telerivet
 #       * Name of the service
 #       * Updatable via API
 #   
+#   - service_type
+#       * Type of the service.
+#       * Read-only
+#   
 #   - active (bool)
 #       * Whether the service is active or inactive. Inactive services are not automatically
 #           triggered and cannot be invoked via the API.
@@ -48,31 +52,48 @@ module Telerivet
 #       * ID of the project this service belongs to
 #       * Read-only
 #   
-#   - label_id
-#       * ID of the label containing messages sent or received by this service (currently only
-#           used for polls)
-#       * Read-only
-#   
 #   - response_table_id
-#       * ID of the data table where responses to this service will be stored (currently only
-#           used for polls)
-#       * Read-only
+#       * ID of the data table where responses to this service will be stored
+#       * Updatable via API
 #   
-#   - sample_group_id
-#       * ID of the group containing contacts that have been invited to interact with this
-#           service (currently only used for polls)
-#       * Read-only
+#   - phone_ids
+#       * 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
 #   
-#   - respondent_group_id
-#       * ID of the group containing contacts that have completed an interaction with this
-#           service (currently only used for polls)
-#       * Read-only
+#   - 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
+#           always be triggered regardless of other services. Only applies to services that handle
+#           incoming messages.
+#       * Allowed values: always, unhandled
+#       * Updatable via API
+#   
+#   - contact_number_filter
+#       * If contact_number_filter is `long_number`, this service will only be triggered if
+#           the contact phone number has at least 7 digits (ignoring messages from shortcodes and
+#           alphanumeric senders). If contact_number_filter is `all`, the service will be
+#           triggered for all contact phone numbers.  Only applies to services that handle
+#           incoming messages.
+#       * Allowed values: long_number, all
+#       * Updatable via API
+#   
+#   - show_action (bool)
+#       * Whether this service is shown in the 'Actions' menu within the Telerivet web app
+#           when the service is active. Only provided for service types that are manually
+#           triggered.
+#       * Updatable via API
+#   
+#   - direction
+#       * Determines whether the service handles incoming voice calls, outgoing voice calls,
+#           or both. Only applies to services that handle voice calls.
+#       * Allowed values: incoming, outgoing, both
+#       * Updatable via API
 #   
-#   - questions (array)
-#       * Array of objects describing each question in a poll (only used for polls). Each
-#           object has the properties `"id"` (the question ID), `"content"` (the text of the
-#           question), and `"question_type"` (either `"multiple_choice"`, `"missed_call"`, or
-#           `"open"`).
+#   - webhook_url
+#       * URL that a third-party can invoke to trigger this service. Only provided for
+#           services that are triggered by a webhook request.
 #       * Read-only
 #
 class Service < Entity
@@ -97,7 +118,7 @@ class Service < Entity
     #     
     #     - context
     #         * The name of the context in which this service is invoked
-    #         * Allowed values: message, call, contact, project
+    #         * Allowed values: message, call, ussd_session, row, contact, project
     #         * Required
     #     
     #     - event
@@ -109,11 +130,49 @@ class Service < Entity
     #         * Required if context is 'message'
     #     
     #     - contact_id
-    #         * The ID of the contact this service is triggered for
-    #         * Required if context is 'contact'
+    #         * The ID of the contact this service is triggered for (either `contact_id` or
+    #             `phone_number` is required if `context` is 'contact')
+    #     
+    #     - phone_number
+    #         * The phone number of the contact this service is triggered for (either `contact_id`
+    #             or `phone_number` is required if `context` is 'contact'). If no  contact exists with
+    #             this phone number, a new contact will be created.
+    #     
+    #     - 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
+    #             (true/false). String values may be up to 4096 bytes in length. Arrays and objects
+    #             are not supported. Within Custom Actions, each variable can be used like `[[$name]]`
+    #             (with a leading `$` character and surrounded by double square brackets). Within a
+    #             Cloud Script API service or JavaScript action, each variable will be available as a
+    #             global JavaScript variable like `$name` (with a leading `$` character).
+    #     
+    #     - route_id
+    #         * The ID of the phone or route that the service will use for sending messages by
+    #             default
+    #     
+    #     - async (bool)
+    #         * If set to true, the service will be invoked asynchronously. By default, queued
+    #             services will be invoked one at a time for each project.
     #   
     # Returns:
-    #     object
+    #     (associative array)
+    #       - return_value (any)
+    #           * Return value of the service. May be any JSON type (boolean, number, string,
+    #               array, object, or null). (Undefined if async=true.)
+    #       
+    #       - log_entries (array)
+    #           * Array of log entry strings generated by the service. (Undefined if async=true.)
+    #       
+    #       - errors (array)
+    #           * Array of error message strings generated by the service. (Undefined if
+    #               async=true.)
+    #       
+    #       - sent_messages (array of objects)
+    #           * Array of messages sent by the service.
+    #       
+    #       - airtime_transactions (array of objects)
+    #           * Array of airtime transactions sent by the service (Undefined if async=true.)
     #
     def invoke(options)        
         invoke_result = @api.do_request('POST', get_base_api_path() + '/invoke', options)
@@ -210,9 +269,9 @@ class Service < Entity
     #     
     #     - vars (Hash)
     #         * Filter states by value of a custom variable (e.g. vars[email], vars[foo], etc.)
-    #         * Allowed modifiers: vars[foo][exists], vars[foo][ne], vars[foo][prefix],
-    #             vars[foo][not_prefix], vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte],
-    #             vars[foo][min], vars[foo][max]
+    #         * Allowed modifiers: vars[foo][ne], vars[foo][prefix], vars[foo][not_prefix],
+    #             vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte], vars[foo][min],
+    #             vars[foo][max], vars[foo][exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -240,6 +299,41 @@ class Service < Entity
         @api.cursor(ContactServiceState, get_base_api_path() + "/states", options)
     end
 
+    #
+    # Gets configuration specific to the type of automated service.
+    # 
+    # Only certain types of services provide their configuration via the
+    # API.
+    # 
+    # Returns:
+    #     object
+    #
+    def get_config()
+        return @api.do_request("GET", get_base_api_path() + "/config")
+    end
+
+    #
+    # Updates configuration specific to the type of automated service.
+    # 
+    # Only certain types of services support updating their configuration
+    # via the API.
+    # 
+    # Note: when updating a service of type custom_template_instance,
+    # the validation script will be invoked when calling this method.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Configuration for this service type. See
+    #           [project.createService](#Project.createService) for available configuration options.
+    #       * Required
+    #   
+    # Returns:
+    #     object
+    #
+    def set_config(options)
+        return @api.do_request("POST", get_base_api_path() + "/config", options)
+    end
+
     #
     # Saves any fields or custom variables that have changed for this service.
     #
@@ -247,6 +341,13 @@ class Service < Entity
         super
     end
 
+    #
+    # Deletes this service.
+    #
+    def delete()
+        @api.do_request("DELETE", get_base_api_path())
+    end
+
     def id
         get('id')
     end
@@ -259,6 +360,10 @@ class Service < Entity
         set('name', value)
     end
 
+    def service_type
+        get('service_type')
+    end
+
     def active
         get('active')
     end
@@ -283,24 +388,56 @@ class Service < Entity
         get('project_id')
     end
 
-    def label_id
-        get('label_id')
-    end
-
     def response_table_id
         get('response_table_id')
     end
 
-    def sample_group_id
-        get('sample_group_id')
+    def response_table_id=(value)
+        set('response_table_id', value)
+    end
+
+    def phone_ids
+        get('phone_ids')
+    end
+
+    def phone_ids=(value)
+        set('phone_ids', value)
+    end
+
+    def apply_mode
+        get('apply_mode')
+    end
+
+    def apply_mode=(value)
+        set('apply_mode', value)
+    end
+
+    def contact_number_filter
+        get('contact_number_filter')
+    end
+
+    def contact_number_filter=(value)
+        set('contact_number_filter', value)
+    end
+
+    def show_action
+        get('show_action')
+    end
+
+    def show_action=(value)
+        set('show_action', value)
+    end
+
+    def direction
+        get('direction')
     end
 
-    def respondent_group_id
-        get('respondent_group_id')
+    def direction=(value)
+        set('direction', value)
     end
 
-    def questions
-        get('questions')
+    def webhook_url
+        get('webhook_url')
     end
 
     def get_base_api_path()

data/lib/telerivet/task.rb

@@ -0,0 +1,151 @@
+
+module Telerivet
+
+#
+# Represents an asynchronous task that is applied to all entities matching a filter.
+# 
+# Tasks include services applied to contacts, messages, or data rows; adding
+# or removing contacts from a group; blocking or unblocking sending messages to a contact;
+# updating a custom variable; deleting contacts, messages, or data rows; or
+# exporting data to CSV.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the task
+#       * Read-only
+#   
+#   - task_type (string)
+#       * The task type
+#       * Read-only
+#   
+#   - task_params (Hash)
+#       * Parameters applied to all matching rows (specific to `task_type`). See
+#           [project.createTask](#Project.createTask).
+#       * Read-only
+#   
+#   - filter_type
+#       * Type of filter defining the rows that the task is applied to
+#       * Read-only
+#   
+#   - filter_params (Hash)
+#       * Parameters defining the rows that the task is applied to (specific to
+#           `filter_type`). See [project.createTask](#Project.createTask).
+#       * Read-only
+#   
+#   - time_created (UNIX timestamp)
+#       * Time the task was created in Telerivet
+#       * Read-only
+#   
+#   - time_active (UNIX timestamp)
+#       * Time Telerivet started executing the task
+#       * Read-only
+#   
+#   - time_complete (UNIX timestamp)
+#       * Time Telerivet finished executing the task
+#       * Read-only
+#   
+#   - total_rows (int)
+#       * The total number of rows matching the filter (null if not known)
+#       * Read-only
+#   
+#   - current_row (int)
+#       * The number of rows that have been processed so far
+#       * Read-only
+#   
+#   - status (string)
+#       * The current status of the task
+#       * Allowed values: created, queued, active, complete, failed, cancelled
+#       * Read-only
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this task
+#       * Read-only
+#   
+#   - table_id (string, max 34 characters)
+#       * ID of the data table this task is applied to (if applicable)
+#       * Read-only
+#   
+#   - user_id (string, max 34 characters)
+#       * ID of the Telerivet user who created the task (if applicable)
+#       * Read-only
+#   
+#   - project_id
+#       * ID of the project this task belongs to
+#       * Read-only
+#
+class Task < Entity
+    #
+    # Cancels a task that is not yet complete.
+    # 
+    # Returns:
+    #     Telerivet::Task
+    #
+    def cancel()
+        require_relative 'task'
+        Task.new(@api, @api.do_request("POST", get_base_api_path() + "/cancel"))
+    end
+
+    def id
+        get('id')
+    end
+
+    def task_type
+        get('task_type')
+    end
+
+    def task_params
+        get('task_params')
+    end
+
+    def filter_type
+        get('filter_type')
+    end
+
+    def filter_params
+        get('filter_params')
+    end
+
+    def time_created
+        get('time_created')
+    end
+
+    def time_active
+        get('time_active')
+    end
+
+    def time_complete
+        get('time_complete')
+    end
+
+    def total_rows
+        get('total_rows')
+    end
+
+    def current_row
+        get('current_row')
+    end
+
+    def status
+        get('status')
+    end
+
+    def table_id
+        get('table_id')
+    end
+
+    def user_id
+        get('user_id')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/tasks/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet.rb

@@ -9,7 +9,7 @@ module Telerivet
 class API
     attr_reader :num_requests
 
-    @@client_version = '1.4.5'
+    @@client_version = '1.7.0'
 
     #
     # 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.4.5
+  version: 1.7.0
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - lib/cacert.pem
 - lib/telerivet.rb
+- lib/telerivet/airtimetransaction.rb
 - lib/telerivet/apicursor.rb
 - lib/telerivet/broadcast.rb
 - lib/telerivet/contact.rb
@@ -31,9 +32,11 @@ files:
 - 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/service.rb
+- lib/telerivet/task.rb
 homepage: http://telerivet.com
 licenses:
 - MIT