telerivet 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d2fced513f7484cd8ea41bc16c1e95a20dbe18d
-  data.tar.gz: e4fc99c1924272a9872262ece7f291c6f92060b4
+SHA256:
+  metadata.gz: 4e063e2ce507f6d45b86d12c584475887c050c3d439863d91d545b0ba331e823
+  data.tar.gz: d8040eb663854c7df190aa8f49984d9854687238532b6278af53dea6ebc77250
 SHA512:
-  metadata.gz: f027ddecadb6e32b3dded7c0ee27b4d7afeede434d02848bc2a23f69186765e2bc77ec0dac6cc4bde926d0959b889e29bf76490037bb24ce19cb772874c21c82
-  data.tar.gz: 82ccab2d76a1b30183d39945d958901fe85ab575003fa1341aca0d5087d3b3a277cd19d0f96126d9a4ad1e01e9de8252556c20e3b0ab8d48b504005d6f869790
+  metadata.gz: da5e09e1c639a5e1bd3b704214c4a276d62469e6ae0853d71cbe4b9dc2a2aacbb1f58d5e5bcbf1093e5cbf24a7a99abcf30d029883aca055d4b41ae9f3a7f8ff
+  data.tar.gz: 4ad80ced036f9d8810e3e7f693443247740791ed4097b26ce179c2c2ef0ca06986b41942fde40401ea8989df19591f84834439efb74900f9bb57ec7f939d8f25

data/lib/telerivet.rb

@@ -9,7 +9,7 @@ module Telerivet
 class API
     attr_reader :num_requests
 
-    @@client_version = '1.4.0'
+    @@client_version = '1.5.0'
 
     #
     # Initializes a client handle to the Telerivet REST API.
@@ -153,7 +153,7 @@ class API
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -222,7 +222,7 @@ class API
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)

data/lib/telerivet/airtimetransaction.rb

@@ -0,0 +1,139 @@
+
+module Telerivet
+
+#
+# Represents a transaction where airtime is sent to a mobile phone number.
+# 
+# To send airtime, first [create a Custom Actions service to send a particular amount of
+# airtime](/dashboard/add_service?subtype_id=main.service.rules.contact&action_id=main.rule.sendairtime),
+# then trigger the service using [service.invoke](#Service.invoke),
+# [project.sendBroadcast](#Project.sendBroadcast), or
+# [project.scheduleMessage](#Project.scheduleMessage).
+# 
+# Fields:
+# 
+#   - id
+#       * ID of the airtime transaction
+#       * Read-only
+#   
+#   - to_number
+#       * Destination phone number in international format (no leading +)
+#       * Read-only
+#   
+#   - operator_name
+#       * Operator name
+#       * Read-only
+#   
+#   - country
+#       * Country code
+#       * Read-only
+#   
+#   - status
+#       * Current status of airtime transaction (`successful`, `failed`, `cancelled`,
+#           `queued`, `pending_approval`, or `pending_payment`)
+#       * Read-only
+#   
+#   - status_text
+#       * Error or success message returned by airtime provider, if available
+#       * Read-only
+#   
+#   - value
+#       * Value of airtime sent to destination phone number, in units of value_currency
+#       * Read-only
+#   
+#   - value_currency
+#       * Currency code of price
+#       * Read-only
+#   
+#   - price
+#       * Price charged for airtime transaction, in units of price_currency
+#       * Read-only
+#   
+#   - price_currency
+#       * Currency code of price
+#       * Read-only
+#   
+#   - contact_id
+#       * ID of the contact the airtime was sent to
+#       * Read-only
+#   
+#   - service_id
+#       * ID of the service that sent the airtime
+#       * Read-only
+#   
+#   - project_id
+#       * ID of the project that the airtime transaction belongs to
+#       * Read-only
+#   
+#   - external_id
+#       * The ID of this transaction from an external airtime gateway provider, if available.
+#       * Read-only
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this transaction
+#       * Updatable via API
+#
+class AirtimeTransaction < Entity
+    def id
+        get('id')
+    end
+
+    def to_number
+        get('to_number')
+    end
+
+    def operator_name
+        get('operator_name')
+    end
+
+    def country
+        get('country')
+    end
+
+    def status
+        get('status')
+    end
+
+    def status_text
+        get('status_text')
+    end
+
+    def value
+        get('value')
+    end
+
+    def value_currency
+        get('value_currency')
+    end
+
+    def price
+        get('price')
+    end
+
+    def price_currency
+        get('price_currency')
+    end
+
+    def contact_id
+        get('contact_id')
+    end
+
+    def service_id
+        get('service_id')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def external_id
+        get('external_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/airtime_transactions/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet/broadcast.rb

@@ -75,7 +75,7 @@ module Telerivet
 #   
 #   - message_type
 #       * Type of message sent from this broadcast
-#       * Allowed values: sms, mms, ussd, call
+#       * Allowed values: sms, mms, ussd, call, service
 #       * Read-only
 #   
 #   - content (string)
@@ -109,7 +109,7 @@ module Telerivet
 #   
 #   - source
 #       * How the message originated within Telerivet
-#       * Allowed values: phone, provider, web, api, service, webhook, scheduled
+#       * Allowed values: phone, provider, web, api, service, webhook, scheduled, integration
 #       * Read-only
 #   
 #   - simulated (bool)
@@ -117,10 +117,29 @@ module Telerivet
 #           sent to or received by a real phone)
 #       * Read-only
 #   
+#   - track_clicks (boolean)
+#       * If true, URLs in the message content will automatically be replaced with unique
+#           short URLs.
+#       * Read-only
+#   
+#   - clicked_count (int)
+#       * The number of messages in this broadcast containing short links that were clicked.
+#           At most one click per message is counted. If track_clicks is false, this property will
+#           be null.
+#       * Read-only
+#   
 #   - label_ids (array)
 #       * List of IDs of labels applied to all messages in the broadcast
 #       * Read-only
 #   
+#   - 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
+#   
 #   - vars (Hash)
 #       * Custom variables stored for this broadcast
 #       * Read-only
@@ -147,6 +166,11 @@ module Telerivet
 #       * ID of the phone or route used to send the broadcast (if applicable)
 #       * Read-only
 #   
+#   - service_id (string, max 34 characters)
+#       * The service associated with this broadcast (for voice calls, the service defines the
+#           call flow)
+#       * Read-only
+#   
 #   - user_id (string, max 34 characters)
 #       * ID of the Telerivet user who sent the broadcast (if applicable)
 #       * Read-only
@@ -242,10 +266,22 @@ class Broadcast < Entity
         get('simulated')
     end
 
+    def track_clicks
+        get('track_clicks')
+    end
+
+    def clicked_count
+        get('clicked_count')
+    end
+
     def label_ids
         get('label_ids')
     end
 
+    def media
+        get('media')
+    end
+
     def price
         get('price')
     end
@@ -266,6 +302,10 @@ class Broadcast < Entity
         get('route_id')
     end
 
+    def service_id
+        get('service_id')
+    end
+
     def user_id
         get('user_id')
     end

data/lib/telerivet/contact.rb

@@ -19,10 +19,19 @@ module Telerivet
 #       * Time the contact was added in Telerivet
 #       * Read-only
 #   
+#   - time_updated (UNIX timestamp)
+#       * Time the contact was last updated in Telerivet
+#       * Read-only
+#   
 #   - send_blocked (bool)
 #       * True if Telerivet is blocked from sending messages to this contact
 #       * Updatable via API
 #   
+#   - conversation_status
+#       * Current status of the conversation with this contact
+#       * Allowed values: closed, active, handled
+#       * Updatable via API
+#   
 #   - last_message_time (UNIX timestamp)
 #       * Last time the contact sent or received a message (null if no messages have been sent
 #           or received)
@@ -125,11 +134,12 @@ class Contact < Entity
     #     
     #     - message_type
     #         * Filter messages by message_type
-    #         * Allowed values: sms, mms, ussd, call
+    #         * Allowed values: sms, mms, ussd, call, service
     #     
     #     - source
     #         * Filter messages by source
-    #         * Allowed values: phone, provider, web, api, service, webhook, scheduled
+    #         * Allowed values: phone, provider, web, api, service, webhook, scheduled,
+    #             integration
     #     
     #     - starred (bool)
     #         * Filter messages by starred/unstarred
@@ -157,6 +167,9 @@ class Contact < Entity
     #     - broadcast_id
     #         * ID of the broadcast containing the message
     #     
+    #     - scheduled_id
+    #         * ID of the scheduled message that created this message
+    #     
     #     - sort
     #         * Sort the results based on a field
     #         * Allowed values: default
@@ -168,7 +181,7 @@ class Contact < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -208,7 +221,7 @@ class Contact < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -232,7 +245,7 @@ class Contact < Entity
     #     
     #     - message_type
     #         * Filter scheduled messages by message_type
-    #         * Allowed values: sms, mms, ussd, call
+    #         * Allowed values: sms, mms, ussd, call, service
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter scheduled messages by time_created
@@ -240,8 +253,8 @@ class Contact < Entity
     #     
     #     - next_time (UNIX timestamp)
     #         * Filter scheduled messages by next_time
-    #         * Allowed modifiers: next_time[exists], next_time[ne], next_time[min],
-    #             next_time[max]
+    #         * Allowed modifiers: next_time[ne], next_time[min], next_time[max],
+    #             next_time[exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -254,7 +267,7 @@ class Contact < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -290,7 +303,7 @@ class Contact < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -318,9 +331,9 @@ class Contact < 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
@@ -333,7 +346,7 @@ class Contact < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -386,6 +399,10 @@ class Contact < Entity
         get('time_created')
     end
 
+    def time_updated
+        get('time_updated')
+    end
+
     def send_blocked
         get('send_blocked')
     end
@@ -394,6 +411,14 @@ class Contact < Entity
         set('send_blocked', value)
     end
 
+    def conversation_status
+        get('conversation_status')
+    end
+
+    def conversation_status=(value)
+        set('conversation_status', value)
+    end
+
     def last_message_time
         get('last_message_time')
     end

data/lib/telerivet/datatable.rb

@@ -22,9 +22,22 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - num_rows (int)
-#       * Number of rows in the table
+#       * Number of rows in the table. For performance reasons, this number may sometimes be
+#           out-of-date.
 #       * Read-only
 #   
+#   - show_add_row (bool)
+#       * Whether to allow adding or importing rows via the web app
+#       * Updatable via API
+#   
+#   - show_stats (bool)
+#       * Whether to show row statistics in the web app
+#       * Updatable via API
+#   
+#   - show_contact_columns (bool)
+#       * Whether to show 'Contact Name' and 'Phone Number' columns in the web app
+#       * Updatable via API
+#   
 #   - vars (Hash)
 #       * Custom variables stored for this data table
 #       * Updatable via API
@@ -49,9 +62,9 @@ class DataTable < Entity
     #     
     #     - vars (Hash)
     #         * Filter data rows by value of a custom variable (e.g. vars[q1], 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
@@ -64,7 +77,7 @@ class DataTable < Entity
     #         * Default: asc
     #     
     #     - page_size (int)
-    #         * Number of results returned per page (max 200)
+    #         * Number of results returned per page (max 500)
     #         * Default: 50
     #     
     #     - offset (int)
@@ -136,8 +149,9 @@ class DataTable < Entity
 
     #
     # Gets a list of all fields (columns) defined for this data table. The return value is an
-    # array of objects with the properties 'name' and 'variable'. (Fields are automatically
-    # created any time a DataRow's 'vars' property is updated.)
+    # array of objects with the properties 'name', 'variable', 'type', 'order', 'readonly', and
+    # 'lookup_key'. (Fields are automatically created any time a DataRow's 'vars' property is
+    # updated.)
     # 
     # Returns:
     #     array
@@ -146,6 +160,37 @@ class DataTable < Entity
         return @api.do_request("GET", get_base_api_path() + "/fields")
     end
 
+    #
+    # Allows customizing how a field (column) is displayed in the Telerivet web app.
+    # 
+    # Arguments:
+    #   - variable
+    #       * The variable name of the field to create or update.
+    #       * Required
+    #   
+    #   - options (Hash)
+    #     
+    #     - name (string, max 64 characters)
+    #         * Display name for the field
+    #     
+    #     - type (string)
+    #         * Field type
+    #         * Allowed values: text, long_text, number, boolean, email, url, audio, phone_number,
+    #             date, date_time, groups, route, select, buttons, contact
+    #     
+    #     - order (int)
+    #         * Order in which to display the field
+    #     
+    #     - readonly (bool)
+    #         * Set to true to prevent editing the field in the Telerivet web app
+    #   
+    # Returns:
+    #     object
+    #
+    def set_field_metadata(variable, options = nil)
+        return @api.do_request("POST", get_base_api_path() + "/fields/#{variable}", options)
+    end
+
     #
     # Returns the number of rows for each value of a given variable. This can be used to get the
     # total number of responses for each choice in a poll, without making a separate query for
@@ -194,6 +239,30 @@ class DataTable < Entity
         get('num_rows')
     end
 
+    def show_add_row
+        get('show_add_row')
+    end
+
+    def show_add_row=(value)
+        set('show_add_row', value)
+    end
+
+    def show_stats
+        get('show_stats')
+    end
+
+    def show_stats=(value)
+        set('show_stats', value)
+    end
+
+    def show_contact_columns
+        get('show_contact_columns')
+    end
+
+    def show_contact_columns=(value)
+        set('show_contact_columns', value)
+    end
+
     def project_id
         get('project_id')
     end