telerivet 1.4.5 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0633af0317a3ef409a86481a483f934d2832d2f6a11fd545221997c3ebb495ad
-  data.tar.gz: 344a694d8cc84a5231cefa14d26f89fceecf6d140f201e013705794684f94015
+  metadata.gz: b442bc6d2aab45f4be47acc976f991bbd399de9a68ac092ec6dd2d717c3373e9
+  data.tar.gz: 7c629053a6f168be87bb4e705e6cad78c9e7ec3aebe34cbb7553843dcf0cb02b
 SHA512:
-  metadata.gz: 74a877df3a572e3b1d96922343d0bc54ed58a2f2d28b36bf883691a3b440244e777cdb74cfed10f701a2f8a768dd157e5ada0f116b1c588774744080699fabc8
-  data.tar.gz: b75d13f319943c2f899200a1845932aad01205a902b280c2128d8bf19c7453b696386a539c278df2a1a19cba14c018189a817a622f2897d229b63eba3f94b7f3
+  metadata.gz: b2585a9e281177331fe9615cbf02d91169f5f6bb178ebe228cd81b4def87576a7486b4e5457261b324f6fe1b958bace906e2e3a28d5b9bef8cb7c77f09bc9586
+  data.tar.gz: 35cb63dc5fbcdb5400808a8f3c4db85e4e5b07d85bd273c01d4693975ae10682e758a67e92797b7e771ccaba6fcd573e3629389aed7696346eff142da6186ef7

data/lib/telerivet.rb

@@ -9,7 +9,7 @@ module Telerivet
 class API
     attr_reader :num_requests
 
-    @@client_version = '1.4.5'
+    @@client_version = '1.4.6'
 
     #
     # Initializes a client handle to the Telerivet REST API.

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

@@ -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)

data/lib/telerivet/contact.rb

@@ -27,6 +27,11 @@ module Telerivet
 #       * 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)
@@ -133,7 +138,8 @@ class Contact < Entity
     #     
     #     - 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
@@ -405,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/label.rb

@@ -43,7 +43,8 @@ class Label < Entity
     #     
     #     - 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

data/lib/telerivet/message.rb

@@ -28,7 +28,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
 #   
 #   - time_created (UNIX timestamp)

data/lib/telerivet/phone.rb

@@ -115,7 +115,8 @@ class Phone < Entity
     #     
     #     - 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

data/lib/telerivet/project.rb

@@ -853,7 +853,8 @@ class Project < Entity
     #     
     #     - 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
@@ -1510,6 +1511,85 @@ class Project < Entity
         return @api.do_request("GET", get_base_api_path() + "/users")
     end
 
+    #
+    # Returns information about each airtime transaction.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #     
+    #     - time_created[min] (UNIX timestamp)
+    #         * Filter transactions created on or after a particular time
+    #     
+    #     - time_created[max] (UNIX timestamp)
+    #         * Filter transactions created before a particular time
+    #     
+    #     - contact_id
+    #         * Filter transactions sent to a particular contact
+    #     
+    #     - to_number
+    #         * Filter transactions sent to a particular phone number
+    #     
+    #     - service_id
+    #         * Filter transactions sent by a particular service
+    #     
+    #     - status
+    #         * Filter transactions by status
+    #         * Allowed values: pending, queued, processing, successful, failed, cancelled,
+    #             pending_payment, pending_approval
+    #     
+    #     - 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 500)
+    #         * Default: 50
+    #     
+    #     - offset (int)
+    #         * Number of items to skip from beginning of result set
+    #         * Default: 0
+    #   
+    # Returns:
+    #     Telerivet::APICursor (of Telerivet::AirtimeTransaction)
+    #
+    def query_airtime_transactions(options = nil)
+        require_relative 'airtimetransaction'
+        @api.cursor(AirtimeTransaction, get_base_api_path() + "/airtime_transactions", options)
+    end
+
+    #
+    # Gets an airtime transaction by ID
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the airtime transaction
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::AirtimeTransaction
+    #
+    def get_airtime_transaction_by_id(id)
+        require_relative 'airtimetransaction'
+        AirtimeTransaction.new(@api, @api.do_request("GET", get_base_api_path() + "/airtime_transactions/#{id}"))
+    end
+
+    #
+    # Initializes an airtime transaction by ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the airtime transaction
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::AirtimeTransaction
+    #
+    def init_airtime_transaction_by_id(id)
+        require_relative 'airtimetransaction'
+        return AirtimeTransaction.new(@api, {'project_id' => self.id, 'id' => id}, false)
+    end
+
     #
     # Saves any fields or custom variables that have changed for the project.
     #

data/lib/telerivet/service.rb

@@ -109,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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerivet
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.4.6
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 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