telerivet 1.8.2 → 1.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fdf6a88c994651145843d843db2ed193cd928ce09331876301801590c5da8e9
-  data.tar.gz: 701d1a9aa6df996e5076f047751e23a9298ee224184de98122ed536f36b7ac44
+  metadata.gz: fa70ed97588b66c3d7fd0d24005b2403babaadec99e991282932c2affb0235dc
+  data.tar.gz: 8ba55152dbe5c5a4fe721de7c1eb4736d0c11ae67085f15c8a45d44489553184
 SHA512:
-  metadata.gz: 6d6613041c5b320de88ca832f34449bdd0192e2bae6cae6038701e57f0ac7d9537ca999a1c9eeb440462b97dfa5137c23a4bf2e6abfbb7d82221d2a28169158a
-  data.tar.gz: bfb351a5d130cb503cd259713670c7c0f6323558fe6f2246d1f83abc27a503c3c55133da04a5f50832736f22e33f31e77dfe0f089ebaa21183eb8626aadd2ac8
+  metadata.gz: ffeac3152f1a8138fd00a43887c17a67a694472f4b66631735f6c71d106d55c56280cf0170b944700ede23c4b4c84718b1eaf92e1ddec92c3922355cc5322112
+  data.tar.gz: 433530a39c90af7ac38e49f093e3a77e91c11777987b4bc0de1b8fd4b013bb798e1d02d8a2a3332a3fc87b34c048680090714f6b2a90ba63bfd440f0ed4d9918

data/lib/telerivet/airtimetransaction.rb

@@ -39,6 +39,8 @@ module Telerivet
 #   - status
 #       * Current status of airtime transaction (`successful`, `failed`, `cancelled`,
 #           `queued`, `processing`, `submitted`, `pending_approval`, or `pending_payment`)
+#       * Allowed values: successful, failed, cancelled, queued, processing, submitted,
+#           pending_approval, pending_payment
 #       * Read-only
 #   
 #   - status_text

data/lib/telerivet/broadcast.rb

@@ -199,6 +199,16 @@ module Telerivet
 #   - project_id
 #       * ID of the project this broadcast belongs to
 #       * Read-only
+#   
+#   - is_template (bool)
+#       * Set to true if Telerivet will render variables like [[contact.name]] in the message
+#           content
+#       * Read-only
+#   
+#   - recipients_str (string)
+#       * A string with a human readable description of the first few recipients (possibly
+#           truncated)
+#       * Read-only
 #
 class Broadcast < Entity
     #
@@ -343,6 +353,14 @@ class Broadcast < Entity
         get('project_id')
     end
 
+    def is_template
+        get('is_template')
+    end
+
+    def recipients_str
+        get('recipients_str')
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/broadcasts/#{get('id')}"
     end

data/lib/telerivet/datatable.rb

@@ -130,32 +130,32 @@ class DataTable < Entity
     # Retrieves the row in the given table with the given ID.
     # 
     # Arguments:
-    #   - id
+    #   - row_id
     #       * ID of the row
     #       * Required
     #   
     # Returns:
     #     Telerivet::DataRow
     #
-    def get_row_by_id(id)
+    def get_row_by_id(row_id)
         require_relative 'datarow'
-        DataRow.new(@api, @api.do_request("GET", get_base_api_path() + "/rows/#{id}"))
+        DataRow.new(@api, @api.do_request("GET", get_base_api_path() + "/rows/#{row_id}"))
     end
 
     #
     # Initializes the row in the given table with the given ID, without making an API request.
     # 
     # Arguments:
-    #   - id
+    #   - row_id
     #       * ID of the row
     #       * Required
     #   
     # Returns:
     #     Telerivet::DataRow
     #
-    def init_row_by_id(id)
+    def init_row_by_id(row_id)
         require_relative 'datarow'
-        return DataRow.new(@api, {'project_id' => self.project_id, 'table_id' => self.id, 'id' => id}, false)
+        return DataRow.new(@api, {'project_id' => self.project_id, 'table_id' => self.id, 'row_id' => row_id}, false)
     end
 
     #
@@ -198,9 +198,9 @@ class DataTable < Entity
     #     
     #     - items (array)
     #         * Array of up to 100 objects containing `value` and `label` string properties to
-    #             show in the dropdown list when type is `select`. Each `value` and `label` must be
-    #             between 1 and 256 characters in length.
-    #         * Required if type is `select`
+    #             show when type is `select` or `radio`. Each `value` and `label` must be between 1
+    #             and 256 characters in length.
+    #         * Required if type is `select` or `radio`
     #     
     #     - readonly (bool)
     #         * Set to true to prevent editing the field in the Telerivet web app

data/lib/telerivet/entity.rb

@@ -51,17 +51,17 @@ class Entity
         @dirty[name] = value
     end
     
-    def save()    
+    def save()
         dirty_props = @dirty
 
         if @vars != nil
             dirty_vars = @vars.get_dirty_variables()
             @dirty['vars'] = dirty_vars if dirty_vars.length() > 0
         end
-            
+
         @api.do_request('POST', get_base_api_path(), @dirty)
         @dirty = {}
-        
+
         @vars.clear_dirty_variables() if @vars != nil
     end
     

data/lib/telerivet/messagetemplate.rb

@@ -0,0 +1,197 @@
+
+module Telerivet
+
+#
+# Represents a reusable message template that can be used when composing or scheduling
+# messages.
+# 
+# Message templates can include placeholder variables using double square
+# brackets (e.g. `[[contact.name]]`) that are replaced with actual values when the message is
+# sent. For available variables, see [Variable Reference](#variables). The double square
+# brackets may also include [filters](/api/rules_engine#filters) to transform variables, such
+# as to set a default value.
+# 
+# Templates synchronized from a WhatsApp Business Account are read-only and
+# cannot be modified or deleted via the API.
+# (When using Telerivet to send messages via a WhatsApp route, Telerivet tries
+# to match the content of each outgoing message to one of these WhatsApp message templates. If
+# a template matches, Telerivet sends a WhatsApp template message instead of a session
+# message.)
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the message template
+#       * Read-only
+#   
+#   - name (string)
+#       * Name of the template (max 127 characters)
+#       * Updatable via API
+#   
+#   - content (string)
+#       * Content of the message template (max 2000 characters)
+#       * Updatable via API
+#   
+#   - track_clicks (bool)
+#       * If true, URLs in the content will be replaced with short links that track clicks
+#           when the template is used
+#       * Updatable via API
+#   
+#   - readonly (bool)
+#       * True if the template cannot be modified or deleted (i.e., it was synchronized from a
+#           WhatsApp Business Account)
+#       * Read-only
+#   
+#   - short_link_params (Hash)
+#       * Custom parameters for short links (only if track_clicks is true)
+#       * Updatable via API
+#   
+#   - attachments (array)
+#       * List of attachment objects with file URLs
+#       * Updatable via API
+#   
+#   - route_params (Hash)
+#       * Route-specific parameters to use when sending messages with this template.
+#           
+#           When sending messages via chat apps such as WhatsApp, the route_params
+#           parameter can be used to send messages with app-specific features such as quick
+#           replies and link buttons.
+#           
+#           For more details, see [Route-Specific Parameters](#route_params).
+#       * Updatable via API
+#   
+#   - waba_id (string)
+#       * ID of the WhatsApp Business Account that this template is associated with (only
+#           present for WhatsApp templates)
+#       * Read-only
+#   
+#   - whatsapp_template (Hash)
+#       * For templates synchronized from a WhatsApp Business Account, contains the full
+#           template data from WhatsApp with properties including `id`, `name`, `language`,
+#           `status`, `category`, and `components`. The full format is defined in the [WhatsApp
+#           Template API
+#           documentation](https://developers.facebook.com/documentation/business-messaging/whatsapp/reference/whatsapp-business-account/template-api#get-version-template-id).
+#           Only present for WhatsApp templates.
+#       * Read-only
+#   
+#   - time_created (UNIX timestamp)
+#       * Time the template was created in Telerivet
+#       * Read-only
+#   
+#   - time_updated (UNIX timestamp)
+#       * Time the template was last updated
+#       * Read-only
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this template. 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 template belongs to
+#       * Read-only
+#
+class MessageTemplate < Entity
+    #
+    # Saves any fields that have changed for the message template.
+    #
+    def save()
+        super
+    end
+
+    #
+    # Deletes the message template.
+    # 
+    # Note: Templates synchronized from a WhatsApp Business Account cannot be deleted via the API.
+    #
+    def delete()
+        @api.do_request("DELETE", get_base_api_path())
+    end
+
+    def id
+        get('id')
+    end
+
+    def name
+        get('name')
+    end
+
+    def name=(value)
+        set('name', value)
+    end
+
+    def content
+        get('content')
+    end
+
+    def content=(value)
+        set('content', value)
+    end
+
+    def track_clicks
+        get('track_clicks')
+    end
+
+    def track_clicks=(value)
+        set('track_clicks', value)
+    end
+
+    def readonly
+        get('readonly')
+    end
+
+    def short_link_params
+        get('short_link_params')
+    end
+
+    def short_link_params=(value)
+        set('short_link_params', value)
+    end
+
+    def attachments
+        get('attachments')
+    end
+
+    def attachments=(value)
+        set('attachments', value)
+    end
+
+    def route_params
+        get('route_params')
+    end
+
+    def route_params=(value)
+        set('route_params', value)
+    end
+
+    def waba_id
+        get('waba_id')
+    end
+
+    def whatsapp_template
+        get('whatsapp_template')
+    end
+
+    def time_created
+        get('time_created')
+    end
+
+    def time_updated
+        get('time_updated')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/message_templates/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet/organization.rb

@@ -51,6 +51,17 @@ class Organization < Entity
     #             contact.
     #         * Default: 1
     #     
+    #     - message_retention_days (int)
+    #         * Number of days to retain messages in this project. Messages older than this will
+    #             be automatically deleted. If null or not provided, messages will be retained
+    #             forever.
+    #     
+    #     - short_link_scheme (bool)
+    #         * If true (the default), short links in messages will include the scheme (e.g.,
+    #             'https://rvt.me/xxxxxxxxx'). If false, short links will not include the scheme
+    #             (e.g., 'rvt.me/xxxxxxxxx').
+    #         * Default: 1
+    #     
     #     - vars
     #         * Custom variables and values to set for this project
     #   
@@ -131,6 +142,8 @@ class Organization < Entity
     # Arguments:
     #   - usage_type
     #       * Usage type.
+    #       * Allowed values: phones, projects, users, contacts, messages_day, stored_messages,
+    #           data_rows, api_requests_day
     #       * Required
     #   
     # Returns:
@@ -191,29 +204,6 @@ class Organization < Entity
     #       - intervals (array)
     #           * List of objects representing each date interval containing at least one message
     #               matching the filters.
-    #               Each object has the following properties:
-    #               
-    #               <table>
-    #               <tr><td> start_time </td> <td> The UNIX timestamp of the start
-    #               of the interval (int) </td></tr>
-    #               <tr><td> end_time </td> <td> The UNIX timestamp of the end of
-    #               the interval, exclusive (int) </td></tr>
-    #               <tr><td> start_date </td> <td> The date of the start of the
-    #               interval in YYYY-MM-DD format (string) </td></tr>
-    #               <tr><td> end_date </td> <td> The date of the end of the
-    #               interval in YYYY-MM-DD format, inclusive (string) </td></tr>
-    #               <tr><td> groups </td> <td> Array of groups for each
-    #               combination of requested property values matching the filters (array)
-    #               <br /><br />
-    #               Each object has the following properties:
-    #               <table>
-    #               <tr><td> properties </td> <td> An object of key/value
-    #               pairs for each distinct value of the requested properties (object) </td></tr>
-    #               <tr><td> metrics </td> <td> An object of key/value pairs
-    #               for each requested metric (object) </td></tr>
-    #               </table>
-    #               </td></tr>
-    #               </table>
     #
     def get_message_stats(options)
         data = @api.do_request("GET", get_base_api_path() + "/message_stats", options)

data/lib/telerivet/phone.rb

@@ -57,6 +57,48 @@ module Telerivet
 #       * ID of the project this phone belongs to
 #       * Read-only
 #   
+#   - validate_recipient_numbers (bool)
+#       * Set to true to check that recipient phone numbers appear to be valid before sending
+#           messages. Messages to invalid phone numbers will fail without being sent. Only applies
+#           to phones capable of sending messages.
+#       * Updatable via API
+#   
+#   - allowed_recipient_countries (array of strings)
+#       * Array of 2-letter country codes (ISO 3166-1 alpha-2) to which this phone is allowed
+#           to send messages. When null, there is no restriction on recipient countries.
+#       * Updatable via API
+#   
+#   - send_delay (number)
+#       * Number of seconds to wait after sending each message from this phone, to avoid
+#           exceeding carrier rate limits.
+#       * Updatable via API
+#   
+#   - timezone_id (string)
+#       * A string specifying the time zone that will be used when implementing quiet hours or
+#           estimating send times; see [List of tz database time zones Wikipedia
+#           article](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones). When null, the
+#           project's default time zone is used.
+#       * Updatable via API
+#   
+#   - quiet_mode (string)
+#       * Controls behavior during quiet hours (see quiet_start/quiet_end). Possible values
+#           are 'off' (quiet hours disabled), 'delay' (messages are delayed until quiet hours
+#           end), or 'confirm' (requires manual confirmation to send during quiet hours).
+#       * Allowed values: off, delay, confirm
+#       * Updatable via API
+#   
+#   - quiet_start (string)
+#       * Time of day when quiet hours begin, in HH:MM format (24-hour time) in the phone's
+#           time zone. Messages sent during quiet hours are delayed or require confirmation
+#           depending on quiet_mode. Only applicable when quiet_mode is not 'off'.
+#       * Updatable via API
+#   
+#   - quiet_end (string)
+#       * Time of day when quiet hours end, in HH:MM format (24-hour time) in the phone's time
+#           zone. Messages sent during quiet hours are delayed or require confirmation depending
+#           on quiet_mode. Only applicable when quiet_mode is not 'off'.
+#       * Updatable via API
+#   
 #   - battery (int)
 #       * Current battery level, on a scale from 0 to 100, as of the last time the phone
 #           connected to Telerivet (only present for Android phones)
@@ -104,6 +146,36 @@ module Telerivet
 #           increase this limit, install additional SMS expansion packs in the Telerivet Gateway
 #           app. (only present for Android phones)
 #       * Read-only
+#   
+#   - external_account_id (string)
+#       * Account ID for the external API (e.g. Twilio Account SID, Vonage API Key). Only
+#           present for routes that support external API configuration. See
+#           [createPhone](#Project.createPhone) for the meaning of this field for each phone type.
+#       * Updatable via API
+#   
+#   - external_id (string)
+#       * External phone/resource ID within the external API account (if applicable). Only
+#           present for routes that support external API configuration.
+#       * Updatable via API
+#   
+#   - external_config (Hash)
+#       * Additional configuration settings specific to the phone_type. Only present for
+#           routes that support external API configuration. See
+#           [createPhone](#Project.createPhone) for available settings for each phone type.
+#       * Updatable via API
+#   
+#   - external_setup (Hash)
+#       * Configuration info for routes that require manual webhook setup. Only present for
+#           routes that require manual configuration of callback URLs with the external provider.
+#           Contains URL properties for each webhook type that needs to be configured (e.g.,
+#           `incoming_message_url`, `message_status_url`, `incoming_call_url`).
+#       * Read-only
+#   
+#   - external_secret (string)
+#       * Secret/API key for the external API (e.g. Twilio Auth Token, Vonage API Secret).
+#           Only applicable for routes that support external API configuration. Write-only; not
+#           returned by the API when retrieving a phone.
+#       * Updatable via API
 #
 class Phone < Entity
     #
@@ -243,6 +315,62 @@ class Phone < Entity
         get('project_id')
     end
 
+    def validate_recipient_numbers
+        get('validate_recipient_numbers')
+    end
+
+    def validate_recipient_numbers=(value)
+        set('validate_recipient_numbers', value)
+    end
+
+    def allowed_recipient_countries
+        get('allowed_recipient_countries')
+    end
+
+    def allowed_recipient_countries=(value)
+        set('allowed_recipient_countries', value)
+    end
+
+    def send_delay
+        get('send_delay')
+    end
+
+    def send_delay=(value)
+        set('send_delay', value)
+    end
+
+    def timezone_id
+        get('timezone_id')
+    end
+
+    def timezone_id=(value)
+        set('timezone_id', value)
+    end
+
+    def quiet_mode
+        get('quiet_mode')
+    end
+
+    def quiet_mode=(value)
+        set('quiet_mode', value)
+    end
+
+    def quiet_start
+        get('quiet_start')
+    end
+
+    def quiet_start=(value)
+        set('quiet_start', value)
+    end
+
+    def quiet_end
+        get('quiet_end')
+    end
+
+    def quiet_end=(value)
+        set('quiet_end', value)
+    end
+
     def battery
         get('battery')
     end
@@ -279,6 +407,42 @@ class Phone < Entity
         get('send_limit')
     end
 
+    def external_account_id
+        get('external_account_id')
+    end
+
+    def external_account_id=(value)
+        set('external_account_id', value)
+    end
+
+    def external_id
+        get('external_id')
+    end
+
+    def external_id=(value)
+        set('external_id', value)
+    end
+
+    def external_config
+        get('external_config')
+    end
+
+    def external_config=(value)
+        set('external_config', value)
+    end
+
+    def external_setup
+        get('external_setup')
+    end
+
+    def external_secret
+        get('external_secret')
+    end
+
+    def external_secret=(value)
+        set('external_secret', value)
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/phones/#{get('id')}"
     end