telerivet 1.3.0 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f29fae453430b0721c120ed759f6471eb6353a5a
-  data.tar.gz: 20efe5389264b4ff2ba936b23a77ff1ade66aec5
+SHA256:
+  metadata.gz: b442bc6d2aab45f4be47acc976f991bbd399de9a68ac092ec6dd2d717c3373e9
+  data.tar.gz: 7c629053a6f168be87bb4e705e6cad78c9e7ec3aebe34cbb7553843dcf0cb02b
 SHA512:
-  metadata.gz: 0caee23855bbca0c7bc86ac0c5c4e057ab11470999871542d884d7c1c381713203f7d2f136653208833a4f5528a40e63965b9a20ea6c8b0fcde6553d2a605ab2
-  data.tar.gz: 39e7a0403bba946173d14ecbe1e02016cf4b160b7e81b06efdd6df18a01178340f015e3b89a93eb5191aa061a04ed30e854cbc31794e8a1cf58007e0fe112d4b
+  metadata.gz: b2585a9e281177331fe9615cbf02d91169f5f6bb178ebe228cd81b4def87576a7486b4e5457261b324f6fe1b958bace906e2e3a28d5b9bef8cb7c77f09bc9586
+  data.tar.gz: 35cb63dc5fbcdb5400808a8f3c4db85e4e5b07d85bd273c01d4693975ae10682e758a67e92797b7e771ccaba6fcd573e3629389aed7696346eff142da6186ef7

data/lib/telerivet.rb

@@ -1,5 +1,6 @@
 require 'net/http'
 require 'json'
+require 'zlib'
 require_relative 'telerivet/entity'
 require_relative 'telerivet/apicursor'
 
@@ -8,7 +9,7 @@ module Telerivet
 class API
     attr_reader :num_requests
 
-    @@client_version = '1.3.0'
+    @@client_version = '1.4.6'
 
     #
     # Initializes a client handle to the Telerivet REST API.
@@ -61,7 +62,14 @@ class API
         if has_post_data
             request.set_content_type("application/json")
             if params != nil
-                request.body = JSON.dump(params)
+                data = JSON.dump(params)
+
+                if data.length >= 400
+                    request['Content-Encoding'] = 'gzip'
+                    data = Zlib::Deflate.new(nil, 31).deflate(data, Zlib::FINISH)
+                end
+
+                request.body = data
             end
         end
 
@@ -145,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)
@@ -214,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,131 @@
+
+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
+#   
+#   - 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 get_base_api_path()
+        "/projects/#{get('project_id')}/airtime_transactions/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet/broadcast.rb

@@ -2,6 +2,13 @@
 module Telerivet
 
 #
+# Represents a collection of related outgoing messages.
+# Typically, messages in a broadcast have the same content template and were
+# sent at the same time; however, a broadcast can also contain messages with unrelated content
+# and messages that were sent at different times.
+# A broadcast is automatically created when sending a message to a group of
+# contacts.
+# 
 # Fields:
 # 
 #   - id (string, max 34 characters)
@@ -25,9 +32,10 @@ module Telerivet
 #           `filter_params` properties, as they may change without notice.)
 #       * Read-only
 #   
-#   - recipients_str
-#       * A string with a human readable description of the first few recipients (possibly
-#           truncated)
+#   - title
+#       * Title of the broadcast. If a title was not provided when the broadcast was sent, it
+#           is automatically set to a human readable description of the first few recipients
+#           (possibly truncated)
 #       * Read-only
 #   
 #   - time_created (UNIX timestamp)
@@ -67,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)
@@ -101,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)
@@ -109,12 +117,31 @@ 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 message
+#       * Custom variables stored for this broadcast
 #       * Read-only
 #   
 #   - price (number)
@@ -139,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
@@ -170,8 +202,8 @@ class Broadcast < Entity
         get('recipients')
     end
 
-    def recipients_str
-        get('recipients_str')
+    def title
+        get('title')
     end
 
     def time_created
@@ -234,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
@@ -258,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
@@ -152,7 +162,13 @@ class Contact < Entity
     #         * ID of the contact who sent/received the message
     #     
     #     - phone_id
-    #         * ID of the phone that sent/received the message
+    #         * ID of the phone (basic route) that sent/received the message
+    #     
+    #     - 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
@@ -165,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)
@@ -205,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)
@@ -229,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
@@ -251,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)
@@ -287,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)
@@ -330,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)
@@ -383,6 +399,10 @@ class Contact < Entity
         get('time_created')
     end
 
+    def time_updated
+        get('time_updated')
+    end
+
     def send_blocked
         get('send_blocked')
     end
@@ -391,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