telerivet 1.5.0 → 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
@@ -117,6 +138,15 @@ 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.
     #     
+    #     - 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
@@ -139,7 +169,7 @@ class Service < Entity
     #               async=true.)
     #       
     #       - sent_messages (array of objects)
-    #           * Array of messages sent by the service (Undefined if async=true.)
+    #           * Array of messages sent by the service.
     #       
     #       - airtime_transactions (array of objects)
     #           * Array of airtime transactions sent by the service (Undefined if async=true.)
@@ -269,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.
     #
@@ -276,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
@@ -288,6 +360,10 @@ class Service < Entity
         set('name', value)
     end
 
+    def service_type
+        get('service_type')
+    end
+
     def active
         get('active')
     end
@@ -312,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.rb

@@ -9,7 +9,7 @@ module Telerivet
 class API
     attr_reader :num_requests
 
-    @@client_version = '1.5.0'
+    @@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.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-27 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
@@ -32,6 +32,7 @@ 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