telerivet 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e007f7fdf619163a3b1d610beae5e36b69ba9909
-  data.tar.gz: a000f816faa4178b51db9da1ccf3aaec5894a184
+  metadata.gz: 318bae0777cbacdccba67044f107f9f2a468b6d5
+  data.tar.gz: 005116ddbd32e76a91feafe5794ff3f13ec3503b
 SHA512:
-  metadata.gz: 406bc716da9060357f419317d31553f0ae691cfaf1e20e69a09e91d9cf86f86bf2d93fc199c5a92803cef6df3dbc3fa38f89f597ecaec19330c144ffde49eafc
-  data.tar.gz: 301f2207986379871faae42ab3aeb7694cd27b38c36df049dfee1aba597cb9dcdc12fc64a919e0e36a1755b8e51ab0e22e4b473c22df225c6b2b8329b64eb62a
+  metadata.gz: 7a6de21710242c4db07004bd23ba4ee6730457a4c03389d34e5bc1d92b4e15fb953003319198e61dd923b20c2a9a1abbfe741109e5cdc156e0dfd07742a760b2
+  data.tar.gz: cd1d5bf58e26fe7e3b5fe6cde3b4152ff8e8d515437fb24cec4440198bf42161d7acb019b252266f4bfa51a535495e76bc56d0b090993e682bee2dfc56b37d9c

data/lib/telerivet.rb

@@ -5,13 +5,10 @@ require_relative 'telerivet/apicursor'
 
 module Telerivet
 
-#
-# 
-#
 class API    
     attr_reader :num_requests
 
-    @@client_version = '1.0.2'
+    @@client_version = '1.1.0'
     
     #
     # Initializes a client handle to the Telerivet REST API.
@@ -89,7 +86,7 @@ class API
             return res    
         end
     end
-    
+
     #
     # Retrieves the Telerivet project with the given ID.
     # 
@@ -103,9 +100,25 @@ class API
     #
     def get_project_by_id(id)
         require_relative 'telerivet/project'
-        Project.new(self, {'id' => id}, false)
+        Project.new(self, self.do_request("GET", get_base_api_path() + "/projects/#{id}"))
     end
-    
+
+    #
+    # Initializes the Telerivet project with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the project -- see <https://telerivet.com/dashboard/api>
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Project
+    #
+    def init_project_by_id(id)
+        require_relative 'telerivet/project'
+        return Project.new(self, {'id' => id}, false)
+    end
+
     #
     # Queries projects accessible to the current user account.
     # 
@@ -140,8 +153,13 @@ class API
     #
     def query_projects(options = nil)
         require_relative 'telerivet/project'
-        cursor(Project, '/projects', options)
+        self.cursor(Project, get_base_api_path() + "/projects", options)
+    end
+
+    def get_base_api_path()
+        ""
     end
+ 
         
     def cursor(item_cls, path, options)
         APICursor.new(self, item_cls, path, options)

data/lib/telerivet/contact.rb

@@ -59,7 +59,7 @@ class Contact < Entity
     #     bool
     #
     def is_in_group?(group)
-        load_data()
+        load()
         return @group_ids_set.has_key?(group.id)
     end
       

data/lib/telerivet/datatable.rb

@@ -4,8 +4,8 @@ module Telerivet
 #
 # Represents a custom data table that can store arbitrary rows.
 # 
-# For example, poll services use data tables to store a row for each response.
-# 
+# For example, poll services use data tables to store a row for each
+# response.
 # 
 # DataTables are schemaless -- each row simply stores custom variables. Each
 # variable name is equivalent to a different "column" of the data table.
@@ -103,8 +103,6 @@ class DataTable < Entity
     #
     # Retrieves the row in the given table with the given ID.
     # 
-    # Note: This does not make any API requests until you access a property of the DataRow.
-    # 
     # Arguments:
     #   - id
     #       * ID of the row
@@ -114,6 +112,22 @@ class DataTable < Entity
     #     Telerivet::DataRow
     #
     def get_row_by_id(id)
+        require_relative 'datarow'
+        DataRow.new(@api, @api.do_request("GET", get_base_api_path() + "/rows/#{id}"))
+    end
+
+    #
+    # Initializes the row in the given table with the given ID, without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the row
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::DataRow
+    #
+    def init_row_by_id(id)
         require_relative 'datarow'
         return DataRow.new(@api, {'project_id' => self.project_id, 'table_id' => self.id, 'id' => id}, false)
     end

data/lib/telerivet/entity.rb

@@ -21,11 +21,13 @@ class Entity
         end
     end
     
-    def load_data()    
+    def load()    
         if !@is_loaded
             @is_loaded = true
             set_data(@api.do_request('GET', get_base_api_path()))
+            @data.merge!(@dirty)
         end
+        self
     end
         
     def vars
@@ -34,21 +36,17 @@ class Entity
         
     def get(name)        
         if @data.has_key?(name)
-            return @data[name]
+            return @data[name]        
         elsif @is_loaded
             return nil
         end
 
-        load_data()
-        
+        load()
+
         return @data[name]
-    end
+    end    
     
     def set(name, value)
-        if !@is_loaded
-            loadData()
-        end
-        
         @data[name] = value
         @dirty[name] = value
     end

data/lib/telerivet/message.rb

@@ -81,7 +81,7 @@ module Telerivet
 #           if available.
 #       * Read-only
 #   
-#   - price
+#   - price (number)
 #       * The price of this message, if known. By convention, message prices are negative.
 #       * Read-only
 #   
@@ -123,7 +123,7 @@ class Message < Entity
     #     bool
     #
     def has_label?(label)
-        load_data()
+        load()
         return @label_ids_set.has_key?(label.id)
     end
       

data/lib/telerivet/project.rb

@@ -311,8 +311,6 @@ class Project < Entity
     #
     # Retrieves the contact with the given ID.
     # 
-    # Note: This does not make any API requests until you access a property of the Contact.
-    # 
     # Arguments:
     #   - id
     #       * ID of the contact
@@ -322,6 +320,22 @@ class Project < Entity
     #     Telerivet::Contact
     #
     def get_contact_by_id(id)
+        require_relative 'contact'
+        Contact.new(@api, @api.do_request("GET", get_base_api_path() + "/contacts/#{id}"))
+    end
+
+    #
+    # Initializes the Telerivet contact with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the contact
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Contact
+    #
+    def init_contact_by_id(id)
         require_relative 'contact'
         return Contact.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
@@ -377,8 +391,6 @@ class Project < Entity
     #
     # Retrieves the phone with the given ID.
     # 
-    # Note: This does not make any API requests until you access a property of the Phone.
-    # 
     # Arguments:
     #   - id
     #       * ID of the phone - see <https://telerivet.com/dashboard/api>
@@ -388,6 +400,22 @@ class Project < Entity
     #     Telerivet::Phone
     #
     def get_phone_by_id(id)
+        require_relative 'phone'
+        Phone.new(@api, @api.do_request("GET", get_base_api_path() + "/phones/#{id}"))
+    end
+
+    #
+    # Initializes the phone with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the phone - see <https://telerivet.com/dashboard/api>
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Phone
+    #
+    def init_phone_by_id(id)
         require_relative 'phone'
         return Phone.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
@@ -459,8 +487,6 @@ class Project < Entity
     #
     # Retrieves the message with the given ID.
     # 
-    # Note: This does not make any API requests until you access a property of the Message.
-    # 
     # Arguments:
     #   - id
     #       * ID of the message
@@ -470,6 +496,22 @@ class Project < Entity
     #     Telerivet::Message
     #
     def get_message_by_id(id)
+        require_relative 'message'
+        Message.new(@api, @api.do_request("GET", get_base_api_path() + "/messages/#{id}"))
+    end
+
+    #
+    # Initializes the Telerivet message with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the message
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Message
+    #
+    def init_message_by_id(id)
         require_relative 'message'
         return Message.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
@@ -530,8 +572,6 @@ class Project < Entity
     #
     # Retrieves the group with the given ID.
     # 
-    # Note: This does not make any API requests until you access a property of the Group.
-    # 
     # Arguments:
     #   - id
     #       * ID of the group
@@ -541,6 +581,22 @@ class Project < Entity
     #     Telerivet::Group
     #
     def get_group_by_id(id)
+        require_relative 'group'
+        Group.new(@api, @api.do_request("GET", get_base_api_path() + "/groups/#{id}"))
+    end
+
+    #
+    # Initializes the group with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the group
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Group
+    #
+    def init_group_by_id(id)
         require_relative 'group'
         return Group.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
@@ -601,8 +657,6 @@ class Project < Entity
     #
     # Retrieves the label with the given ID.
     # 
-    # Note: This does not make any API requests until you access a property of the Label.
-    # 
     # Arguments:
     #   - id
     #       * ID of the label
@@ -612,6 +666,22 @@ class Project < Entity
     #     Telerivet::Label
     #
     def get_label_by_id(id)
+        require_relative 'label'
+        Label.new(@api, @api.do_request("GET", get_base_api_path() + "/labels/#{id}"))
+    end
+
+    #
+    # Initializes the label with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the label
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Label
+    #
+    def init_label_by_id(id)
         require_relative 'label'
         return Label.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
@@ -672,8 +742,6 @@ class Project < Entity
     #
     # Retrieves the data table with the given ID.
     # 
-    # Note: This does not make any API requests until you access a property of the DataTable.
-    # 
     # Arguments:
     #   - id
     #       * ID of the data table
@@ -683,6 +751,22 @@ class Project < Entity
     #     Telerivet::DataTable
     #
     def get_data_table_by_id(id)
+        require_relative 'datatable'
+        DataTable.new(@api, @api.do_request("GET", get_base_api_path() + "/tables/#{id}"))
+    end
+
+    #
+    # Initializes the data table with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the data table
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::DataTable
+    #
+    def init_data_table_by_id(id)
         require_relative 'datatable'
         return DataTable.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
@@ -735,9 +819,6 @@ class Project < Entity
     #
     # Retrieves the scheduled message with the given ID.
     # 
-    # Note: This does not make any API requests until you access a property of the
-    # ScheduledMessage.
-    # 
     # Arguments:
     #   - id
     #       * ID of the scheduled message
@@ -747,6 +828,22 @@ class Project < Entity
     #     Telerivet::ScheduledMessage
     #
     def get_scheduled_message_by_id(id)
+        require_relative 'scheduledmessage'
+        ScheduledMessage.new(@api, @api.do_request("GET", get_base_api_path() + "/scheduled/#{id}"))
+    end
+
+    #
+    # Initializes the scheduled message with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the scheduled message
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::ScheduledMessage
+    #
+    def init_scheduled_message_by_id(id)
         require_relative 'scheduledmessage'
         return ScheduledMessage.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
@@ -798,8 +895,6 @@ class Project < Entity
     #
     # Retrieves the service with the given ID.
     # 
-    # Note: This does not make any API requests until you access a property of the Service.
-    # 
     # Arguments:
     #   - id
     #       * ID of the service
@@ -809,6 +904,22 @@ class Project < Entity
     #     Telerivet::Service
     #
     def get_service_by_id(id)
+        require_relative 'service'
+        Service.new(@api, @api.do_request("GET", get_base_api_path() + "/services/#{id}"))
+    end
+
+    #
+    # Initializes the service with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the service
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Service
+    #
+    def init_service_by_id(id)
         require_relative 'service'
         return Service.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
@@ -871,9 +982,6 @@ class Project < Entity
     #
     # Retrieves the mobile money receipt with the given ID.
     # 
-    # Note: This does not make any API requests until you access a property of the
-    # MobileMoneyReceipt.
-    # 
     # Arguments:
     #   - id
     #       * ID of the mobile money receipt
@@ -883,10 +991,95 @@ class Project < Entity
     #     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).
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #     
+    #     - name
+    #         * Filter routes by name
+    #         * Allowed modifiers: name[ne], name[prefix], name[not_prefix], name[gte], name[gt],
+    #             name[lt], name[lte]
+    #     
+    #     - sort
+    #         * Sort the results based on a field
+    #         * Allowed values: default, name
+    #         * 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::Route)
+    #
+    def query_routes(options = nil)
+        require_relative 'route'
+        @api.cursor(Route, get_base_api_path() + "/routes", options)
+    end
+
+    #
+    # Gets a custom route by ID
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the route
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Route
+    #
+    def get_route_by_id(id)
+        require_relative 'route'
+        Route.new(@api, @api.do_request("GET", get_base_api_path() + "/routes/#{id}"))
+    end
+
+    #
+    # Initializes a custom route by ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the route
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Route
+    #
+    def init_route_by_id(id)
+        require_relative 'route'
+        return Route.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/route.rb

@@ -0,0 +1,57 @@
+
+module Telerivet
+
+#
+# Represents a custom route that can be used to send messages via one or more Phones.
+# 
+# Note: Routing rules can currently only be configured via Telerivet's web UI.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * Telerivet's internal ID for the route
+#       * Read-only
+#   
+#   - name
+#       * The name of the route
+#       * Updatable via API
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this route
+#       * Updatable via API
+#   
+#   - project_id
+#       * ID of the project this route belongs to
+#       * Read-only
+#
+class Route < Entity
+    #
+    # Saves any fields or custom variables that have changed for this route.
+    #
+    def save()
+        super
+    end
+
+    def id
+        get('id')
+    end
+
+    def name
+        get('name')
+    end
+
+    def name=(value)
+        set('name', value)
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/routes/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet/scheduledmessage.rb

@@ -72,7 +72,7 @@ module Telerivet
 #       * Number of times this scheduled message has already been sent
 #       * Read-only
 #   
-#   - is_template
+#   - is_template (bool)
 #       * Set to true if Telerivet will render variables like [[contact.name]] in the message
 #           content, false otherwise
 #       * Read-only

data/lib/telerivet/service.rb

@@ -102,6 +102,9 @@ class Service < Entity
     #     - contact_id
     #         * The ID of the contact this service is triggered for
     #         * Required if context is 'contact'
+    #   
+    # Returns:
+    #     object
     #
     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.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-06 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com
@@ -30,6 +30,7 @@ files:
 - lib/telerivet/mobilemoneyreceipt.rb
 - lib/telerivet/phone.rb
 - lib/telerivet/project.rb
+- lib/telerivet/route.rb
 - lib/telerivet/scheduledmessage.rb
 - lib/telerivet/service.rb
 homepage: http://telerivet.com