telerivet 1.3.0 → 1.4.6

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:
 # 

data/lib/telerivet/scheduledmessage.rb

@@ -87,7 +87,7 @@ module Telerivet
 #   
 #   - message_type
 #       * Type of scheduled message
-#       * Allowed values: sms, ussd, call
+#       * Allowed values: sms, mms, ussd, call, service
 #       * Read-only
 #   
 #   - time_created (UNIX timestamp)
@@ -122,6 +122,19 @@ module Telerivet
 #           content, false otherwise
 #       * Read-only
 #   
+#   - track_clicks (boolean)
+#       * If true, URLs in the message content will automatically be replaced with unique
+#           short URLs
+#       * 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 scheduled message (copied to Message when sent)
 #       * Updatable via API
@@ -237,6 +250,14 @@ class ScheduledMessage < Entity
         get('is_template')
     end
 
+    def track_clicks
+        get('track_clicks')
+    end
+
+    def media
+        get('media')
+    end
+
     def label_ids
         get('label_ids')
     end

data/lib/telerivet/service.rb

@@ -82,7 +82,9 @@ class Service < Entity
     # 
     # For example, to send a poll to a particular contact (or resend the
     # current question), you can invoke the poll service with context=contact, and `contact_id` as
-    # the ID of the contact to send the poll to.
+    # the ID of the contact to send the poll to. (To trigger a service to multiple contacts, use
+    # [project.sendBroadcast](#Project.sendBroadcast). To schedule a service in the future, use
+    # [project.scheduleMessage](#Project.scheduleMessage).)
     # 
     # Or, to manually apply a service for an incoming message, you can
     # invoke the service with `context`=`message`, `event`=`incoming_message`, and `message_id` as
@@ -107,11 +109,35 @@ class Service < Entity
     #         * Required if context is 'message'
     #     
     #     - contact_id
-    #         * The ID of the contact this service is triggered for
-    #         * Required if context is 'contact'
+    #         * The ID of the contact this service is triggered for (either `contact_id` or
+    #             `phone_number` is required if `context` is 'contact')
+    #     
+    #     - phone_number
+    #         * The phone number of the contact this service is triggered for (either `contact_id`
+    #             or `phone_number` is required if `context` is 'contact'). If no  contact exists with
+    #             this phone number, a new contact will be created.
+    #     
+    #     - route_id
+    #         * The ID of the phone or route that the service will use for sending messages by
+    #             default
     #   
     # Returns:
-    #     object
+    #     (associative array)
+    #       - return_value (any)
+    #           * Return value of the service. May be any JSON type (boolean, number, string,
+    #               array, object, or null).
+    #       
+    #       - log_entries (array)
+    #           * Array of log entry strings generated by the service
+    #       
+    #       - errors (array)
+    #           * Array of error message strings generated by the service
+    #       
+    #       - sent_messages (array of objects)
+    #           * Array of messages sent by the service
+    #       
+    #       - airtime_transactions (array of objects)
+    #           * Array of airtime transactions sent by the service
     #
     def invoke(options)        
         invoke_result = @api.do_request('POST', get_base_api_path() + '/invoke', options)
@@ -223,7 +249,7 @@ class Service < 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerivet
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.6
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - lib/cacert.pem
 - lib/telerivet.rb
+- lib/telerivet/airtimetransaction.rb
 - lib/telerivet/apicursor.rb
 - lib/telerivet/broadcast.rb
 - lib/telerivet/contact.rb
@@ -28,7 +29,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
@@ -54,8 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Telerivet REST API Client

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