telerivet 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f29fae453430b0721c120ed759f6471eb6353a5a
-  data.tar.gz: 20efe5389264b4ff2ba936b23a77ff1ade66aec5
+  metadata.gz: 2d2fced513f7484cd8ea41bc16c1e95a20dbe18d
+  data.tar.gz: e4fc99c1924272a9872262ece7f291c6f92060b4
 SHA512:
-  metadata.gz: 0caee23855bbca0c7bc86ac0c5c4e057ab11470999871542d884d7c1c381713203f7d2f136653208833a4f5528a40e63965b9a20ea6c8b0fcde6553d2a605ab2
-  data.tar.gz: 39e7a0403bba946173d14ecbe1e02016cf4b160b7e81b06efdd6df18a01178340f015e3b89a93eb5191aa061a04ed30e854cbc31794e8a1cf58007e0fe112d4b
+  metadata.gz: f027ddecadb6e32b3dded7c0ee27b4d7afeede434d02848bc2a23f69186765e2bc77ec0dac6cc4bde926d0959b889e29bf76490037bb24ce19cb772874c21c82
+  data.tar.gz: 82ccab2d76a1b30183d39945d958901fe85ab575003fa1341aca0d5087d3b3a277cd19d0f96126d9a4ad1e01e9de8252556c20e3b0ab8d48b504005d6f869790

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.0'
 
     #
     # 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
 

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)
@@ -114,7 +122,7 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this message
+#       * Custom variables stored for this broadcast
 #       * Read-only
 #   
 #   - price (number)
@@ -170,8 +178,8 @@ class Broadcast < Entity
         get('recipients')
     end
 
-    def recipients_str
-        get('recipients_str')
+    def title
+        get('title')
     end
 
     def time_created

data/lib/telerivet/contact.rb

@@ -152,7 +152,10 @@ 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
     #     
     #     - sort
     #         * Sort the results based on a field

data/lib/telerivet/label.rb

@@ -66,7 +66,10 @@ class Label < 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
     #     
     #     - sort
     #         * Sort the results based on a field

data/lib/telerivet/message.rb

@@ -128,7 +128,7 @@ module Telerivet
 #       * Read-only
 #   
 #   - phone_id (string, max 34 characters)
-#       * ID of the phone that sent or received the message
+#       * ID of the phone (basic route) that sent or received the message
 #       * Read-only
 #   
 #   - contact_id (string, max 34 characters)
@@ -136,7 +136,7 @@ module Telerivet
 #       * Read-only
 #   
 #   - route_id (string, max 34 characters)
-#       * ID of the route that sent the message (if applicable)
+#       * ID of the custom route that sent the message (if applicable)
 #       * Read-only
 #   
 #   - broadcast_id (string, max 34 characters)

data/lib/telerivet/phone.rb

@@ -4,6 +4,10 @@ module Telerivet
 #
 # Represents a phone or gateway that you use to send/receive messages via Telerivet.
 # 
+# Basic Routes were formerly referred to as "Phones" within Telerivet. API
+# methods, parameters, and properties related to Basic Routes continue to use the term "Phone"
+# to maintain backwards compatibility.
+# 
 # Fields:
 # 
 #   - id (string, max 34 characters)
@@ -15,11 +19,11 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - phone_number (string)
-#       * Phone number of the phone
+#       * Phone number or sender ID
 #       * Updatable via API
 #   
 #   - phone_type
-#       * Type of this phone/gateway (e.g. android, twilio, nexmo, etc)
+#       * Type of this phone/route (e.g. android, twilio, nexmo, etc)
 #       * Read-only
 #   
 #   - country
@@ -134,7 +138,10 @@ class Phone < 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
     #     
     #     - sort
     #         * Sort the results based on a field

data/lib/telerivet/project.rb

@@ -63,7 +63,7 @@ class Project < Entity
     #     
     #     - route_id
     #         * ID of the phone or route to send the message from
-    #         * Default: default sender phone ID for your project
+    #         * Default: default sender route ID for your project
     #     
     #     - service_id
     #         * Service that defines the call flow of the voice call (when `message_type` is
@@ -113,14 +113,6 @@ class Project < Entity
     #             will attempt to send messages with higher priority numbers first (for example, so
     #             you can prioritize an auto-reply ahead of a bulk message to a large group).
     #         * Default: 1
-    #     
-    #     - user_id
-    #         * ID of the Telerivet user account that sent the message (use
-    #             [project.getUsers](#Project.getUsers) to look up user IDs). In order to use this
-    #             parameter, the user account associated with the API key must have administrator
-    #             permissions for the project, and the user account associated with the user_id
-    #             parameter must have access to the project.
-    #         * Default: User account associated with the API key
     #   
     # Returns:
     #     Telerivet::Message
@@ -131,7 +123,7 @@ class Project < Entity
     end
 
     #
-    # Sends an SMS message (optionally with mail-merge templates) or voice call to a group or a
+    # Sends a text message (optionally with mail-merge templates) or voice call to a group or a
     # list of up to 500 phone numbers
     # 
     # Arguments:
@@ -157,7 +149,11 @@ class Project < Entity
     #     
     #     - route_id
     #         * ID of the phone or route to send the message from
-    #         * Default: default sender phone ID
+    #         * Default: default sender route ID
+    #     
+    #     - title (string)
+    #         * Title of the broadcast. If a title is not provided, a title will automatically be
+    #             generated from the recipient group name or phone numbers.
     #     
     #     - service_id
     #         * Service that defines the call flow of the voice call (when `message_type` is
@@ -207,13 +203,106 @@ class Project < Entity
     #         * Custom variables to set for each message
     #   
     # Returns:
+    #     Telerivet::Broadcast
+    #
+    def send_broadcast(options)
+        require_relative 'broadcast'
+        Broadcast.new(@api, @api.do_request("POST", get_base_api_path() + "/send_broadcast", options))
+    end
+
+    #
+    # Sends up to 100 different messages in a single API request. This method is significantly
+    # faster than sending a separate API request for each message.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - messages (array)
+    #         * Array of up to 100 objects with `content` and `to_number` properties
+    #         * Required
+    #     
+    #     - message_type
+    #         * Type of message to send
+    #         * Allowed values: sms
+    #         * Default: sms
+    #     
+    #     - route_id
+    #         * ID of the phone or route to send the messages from
+    #         * Default: default sender route ID
+    #     
+    #     - broadcast_id (string)
+    #         * ID of an existing broadcast to associate the messages with
+    #     
+    #     - broadcast_title (string)
+    #         * Title of broadcast to create (when `broadcast_id` is not provided).
+    #             When sending more than 100 messages over multiple API
+    #             requests, you can associate all messages with the same broadcast by providing a
+    #             `broadcast_title` parameter in the first
+    #             API request, then retrieving the `broadcast_id` property
+    #             from the API response, and passing it as the `broadcast_id` parameter in subsequent
+    #             API requests.
+    #     
+    #     - status_url
+    #         * Webhook callback URL to be notified when message status changes
+    #     
+    #     - status_secret
+    #         * POST parameter 'secret' passed to status_url
+    #     
+    #     - label_ids (array)
+    #         * Array of IDs of labels to add to each message (maximum 5)
+    #     
+    #     - is_template (bool)
+    #         * Set to true to evaluate variables like [[contact.name]] in message content [(See
+    #             available variables)](#variables)
+    #         * Default: false
+    #   
+    # Returns:
+    #     (associative array)
+    #       - messages (array)
+    #           * List of objects representing each newly created message, with the same length
+    #               and order as provided in the `messages` parameter in the API request.
+    #               Each object has the `id` and `status` properties,
+    #               and may have the property `error_message`.
+    #               (Other properties of the Message object are
+    #               omitted in order to reduce the amount of redundant data sent in each API
+    #               response.)
+    #       
+    #       - broadcast_id
+    #           * ID of broadcast that these messages are associated with, if `broadcast_id` or
+    #               `broadcast_title` parameter is provided in the API request.
+    #
+    def send_multi(options)
+        data = @api.do_request("POST", get_base_api_path() + "/send_multi", options)
+        return data
+    end
+
+    #
+    # (Deprecated) Send a message a to group or a list of phone numbers.
+    # This method is only needed to maintain backward compatibility with
+    # code developed using previous versions of the client library.
+    # Use `sendBroadcast` or `sendMulti` instead.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - message_type
+    #     
+    #     - content
+    #         * Required
+    #     
+    #     - group_id
+    #     
+    #     - to_numbers
+    #   
+    # Returns:
     #     (associative array)
     #       - count_queued (int)
     #           * Number of messages queued to send
     #       
     #       - broadcast_id
-    #           * ID of broadcast created for this message batch. If `count_queued` is 0 or 1, a
-    #               broadcast will not be created, and the `broadcast_id` property will be null.
+    #           * ID of broadcast created for this message batch.
     #
     def send_messages(options)
         data = @api.do_request("POST", get_base_api_path() + "/messages/send_batch", options)
@@ -262,7 +351,7 @@ class Project < Entity
     #     
     #     - route_id
     #         * ID of the phone or route to send the message from
-    #         * Default: default sender phone ID
+    #         * Default: default sender route ID
     #     
     #     - service_id
     #         * Service that defines the call flow of the voice call (when `message_type` is
@@ -339,7 +428,7 @@ class Project < Entity
     #         * Required
     #     
     #     - phone_id
-    #         * ID of the phone that received the message
+    #         * ID of the phone (basic route) that received the message
     #         * Required
     #     
     #     - to_number
@@ -657,7 +746,10 @@ class Project < 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
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -1204,93 +1296,6 @@ class Project < Entity
         return Service.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
 
-    #
-    # Queries mobile money receipts within the given project.
-    # 
-    # Arguments:
-    #   - options (Hash)
-    #     
-    #     - tx_id
-    #         * Filter receipts by transaction ID
-    #     
-    #     - tx_type
-    #         * Filter receipts by transaction type
-    #         * Allowed values: receive_money, send_money, pay_bill, deposit, withdrawal,
-    #             airtime_purchase, balance_inquiry, reversal
-    #     
-    #     - tx_time (UNIX timestamp)
-    #         * Filter receipts by transaction time
-    #         * Allowed modifiers: tx_time[ne], tx_time[min], tx_time[max]
-    #     
-    #     - name
-    #         * Filter receipts by other person's name
-    #         * Allowed modifiers: name[ne], name[prefix], name[not_prefix], name[gte], name[gt],
-    #             name[lt], name[lte]
-    #     
-    #     - phone_number
-    #         * Filter receipts by other person's phone number
-    #         * Allowed modifiers: phone_number[ne], phone_number[prefix],
-    #             phone_number[not_prefix], phone_number[gte], phone_number[gt], phone_number[lt],
-    #             phone_number[lte]
-    #     
-    #     - sort
-    #         * Sort the results based on a field
-    #         * Allowed values: default
-    #         * Default: default
-    #     
-    #     - sort_dir
-    #         * Sort the results in ascending or descending order
-    #         * Allowed values: asc, desc
-    #         * Default: asc
-    #     
-    #     - page_size (int)
-    #         * Number of results returned per page (max 200)
-    #         * Default: 50
-    #     
-    #     - offset (int)
-    #         * Number of items to skip from beginning of result set
-    #         * Default: 0
-    #   
-    # Returns:
-    #     Telerivet::APICursor (of Telerivet::MobileMoneyReceipt)
-    #
-    def query_receipts(options = nil)
-        require_relative 'mobilemoneyreceipt'
-        @api.cursor(MobileMoneyReceipt, get_base_api_path() + "/receipts", options)
-    end
-
-    #
-    # Retrieves the mobile money receipt with the given ID.
-    # 
-    # Arguments:
-    #   - id
-    #       * ID of the mobile money receipt
-    #       * Required
-    #   
-    # Returns:
-    #     Telerivet::MobileMoneyReceipt
-    #
-    def get_receipt_by_id(id)
-        require_relative 'mobilemoneyreceipt'
-        MobileMoneyReceipt.new(@api, @api.do_request("GET", get_base_api_path() + "/receipts/#{id}"))
-    end
-
-    #
-    # Initializes the mobile money receipt with the given ID without making an API request.
-    # 
-    # Arguments:
-    #   - id
-    #       * ID of the mobile money receipt
-    #       * Required
-    #   
-    # Returns:
-    #     Telerivet::MobileMoneyReceipt
-    #
-    def init_receipt_by_id(id)
-        require_relative 'mobilemoneyreceipt'
-        return MobileMoneyReceipt.new(@api, {'project_id' => self.id, 'id' => id}, false)
-    end
-
     #
     # Queries custom routes that can be used to send messages (not including Phones).
     # 

data/lib/telerivet/route.rb

@@ -2,9 +2,15 @@
 module Telerivet
 
 #
-# Represents a custom route that can be used to send messages via one or more Phones.
+# Represents a custom route that can be used to send messages via one or more basic routes
+# (phones).
 # 
-# Note: Routing rules can currently only be configured via Telerivet's web UI.
+# Custom Routes were formerly referred to simply as "Routes" within Telerivet. API methods,
+# parameters, and properties related to Custom Routes continue to use the term "Route" to
+# maintain backwards compatibility.
+# 
+# Custom routing rules can currently only be configured via Telerivet's web
+# UI.
 # 
 # Fields:
 # 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerivet
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com
@@ -28,7 +28,6 @@ files:
 - lib/telerivet/group.rb
 - lib/telerivet/label.rb
 - lib/telerivet/message.rb
-- lib/telerivet/mobilemoneyreceipt.rb
 - lib/telerivet/organization.rb
 - lib/telerivet/phone.rb
 - lib/telerivet/project.rb

data/lib/telerivet/mobilemoneyreceipt.rb

@@ -1,187 +0,0 @@
-
-module Telerivet
-
-#
-# Represents a receipt received from a mobile money system such as Safaricom M-Pesa (Kenya),
-# Vodacom M-Pesa (Tanzania), or Tigo Pesa (Tanzania).
-# 
-# When your Android phone receives a SMS receipt from a supported mobile money
-# service that Telerivet can understand, Telerivet will automatically parse it and create a
-# MobileMoneyReceipt object.
-# 
-# Fields:
-# 
-#   - id (string, max 34 characters)
-#       * Telerivet's internal ID for the receipt
-#       * Read-only
-#   
-#   - tx_id
-#       * Transaction ID from the receipt
-#       * Read-only
-#   
-#   - tx_type
-#       * Type of mobile money transaction
-#       * Allowed values: receive_money, send_money, pay_bill, deposit, withdrawal,
-#           airtime_purchase, balance_inquiry, reversal
-#       * Read-only
-#   
-#   - currency
-#       * [ISO 4217 Currency code](http://en.wikipedia.org/wiki/ISO_4217) for the transaction,
-#           e.g. KES or TZS. Amount, balance, and fee are expressed in units of this currency.
-#       * Read-only
-#   
-#   - amount (number)
-#       * Amount of this transaction; positive numbers indicate money added to your account,
-#           negative numbers indicate money removed from your account
-#       * Read-only
-#   
-#   - balance (number)
-#       * The current balance of your mobile money account (null if not available)
-#       * Read-only
-#   
-#   - fee (number)
-#       * The transaction fee charged by the mobile money system (null if not available)
-#       * Read-only
-#   
-#   - name
-#       * The name of the other person in the transaction (null if not available)
-#       * Read-only
-#   
-#   - phone_number
-#       * The phone number of the other person in the transaction (null if not available)
-#       * Read-only
-#   
-#   - time_created (UNIX timestamp)
-#       * The time this receipt was created in Telerivet
-#       * Read-only
-#   
-#   - other_tx_id
-#       * The other transaction ID listed in the receipt (e.g. the transaction ID for a
-#           reversed transaction)
-#       * Read-only
-#   
-#   - content
-#       * The raw content of the mobile money receipt
-#       * Read-only
-#   
-#   - provider_id
-#       * Telerivet's internal ID for the mobile money provider
-#       * Read-only
-#   
-#   - vars (Hash)
-#       * Custom variables stored for this mobile money receipt
-#       * Updatable via API
-#   
-#   - contact_id
-#       * ID of the contact associated with the name/phone number on the receipt. Note that
-#           some mobile money systems do not provide the other person's phone number, so it's
-#           possible Telerivet may not automatically assign a contact_id, or may assign it to a
-#           different contact with the same name.
-#       * Updatable via API
-#   
-#   - phone_id
-#       * ID of the phone that received the receipt
-#       * Read-only
-#   
-#   - message_id
-#       * ID of the message corresponding to the receipt
-#       * Read-only
-#   
-#   - project_id
-#       * ID of the project this receipt belongs to
-#       * Read-only
-#
-class MobileMoneyReceipt < Entity
-    #
-    # Saves any fields or custom variables that have changed for this mobile money receipt.
-    #
-    def save()
-        super
-    end
-
-    #
-    # Deletes this receipt.
-    #
-    def delete()
-        @api.do_request("DELETE", get_base_api_path())
-    end
-
-    def id
-        get('id')
-    end
-
-    def tx_id
-        get('tx_id')
-    end
-
-    def tx_type
-        get('tx_type')
-    end
-
-    def currency
-        get('currency')
-    end
-
-    def amount
-        get('amount')
-    end
-
-    def balance
-        get('balance')
-    end
-
-    def fee
-        get('fee')
-    end
-
-    def name
-        get('name')
-    end
-
-    def phone_number
-        get('phone_number')
-    end
-
-    def time_created
-        get('time_created')
-    end
-
-    def other_tx_id
-        get('other_tx_id')
-    end
-
-    def content
-        get('content')
-    end
-
-    def provider_id
-        get('provider_id')
-    end
-
-    def contact_id
-        get('contact_id')
-    end
-
-    def contact_id=(value)
-        set('contact_id', value)
-    end
-
-    def phone_id
-        get('phone_id')
-    end
-
-    def message_id
-        get('message_id')
-    end
-
-    def project_id
-        get('project_id')
-    end
-
-    def get_base_api_path()
-        "/projects/#{get('project_id')}/receipts/#{get('id')}"
-    end
- 
-end
-
-end