telerivet 1.8.2 → 1.9.6

data/lib/telerivet/datatable.rb

@@ -51,6 +51,10 @@ module Telerivet
 #   - project_id
 #       * ID of the project this data table belongs to
 #       * Read-only
+#   
+#   - url
+#       * URL to this data table in the Telerivet web app
+#       * Read-only
 #
 class DataTable < Entity
     #
@@ -126,36 +130,177 @@ class DataTable < Entity
         DataRow.new(@api, @api.do_request("POST", get_base_api_path() + "/rows", options))
     end
 
+    #
+    # Creates and/or updates up to 200 rows in a single API call. When creating or updating a
+    # large number of rows, this method is significantly faster than sending a separate API
+    # request for each row.
+    # 
+    # By default, a new row will be created for each item. To update
+    # existing rows, set the `lookup_key` parameter to match rows by ID, contact, or the value of
+    # a custom variable.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - rows (array)
+    #         * Array of up to 200 objects which may contain the properties `vars` (object),
+    #             `contact_id` (string), `from_number` (string), and `id` (string). All properties are
+    #             optional, unless used as a lookup key.
+    #         * Required
+    #     
+    #     - lookup_key
+    #         * The field used to search for a matching row, or 'none' to always create a new row.
+    #             To search by a custom variable, precede the variable name with 'vars.'.
+    #         * Allowed values: none, id, contact_id, vars.variable_name
+    #         * Default: none
+    #   
+    # Returns:
+    #     (associative array)
+    #       - rows (array)
+    #           * List of objects representing each row, in the same order as provided in the
+    #               `rows` parameter in the API request.
+    #
+    def import_rows(options)
+        data = @api.do_request("POST", get_base_api_path() + "/import_rows", options)
+        return data
+    end
+
     #
     # Retrieves the row in the given table with the given ID.
     # 
     # Arguments:
-    #   - id
+    #   - row_id
     #       * ID of the row
     #       * Required
     #   
     # Returns:
     #     Telerivet::DataRow
     #
-    def get_row_by_id(id)
+    def get_row_by_id(row_id)
         require_relative 'datarow'
-        DataRow.new(@api, @api.do_request("GET", get_base_api_path() + "/rows/#{id}"))
+        DataRow.new(@api, @api.do_request("GET", get_base_api_path() + "/rows/#{row_id}"))
     end
 
     #
     # Initializes the row in the given table with the given ID, without making an API request.
     # 
     # Arguments:
-    #   - id
+    #   - row_id
     #       * ID of the row
     #       * Required
     #   
     # Returns:
     #     Telerivet::DataRow
     #
-    def init_row_by_id(id)
+    def init_row_by_id(row_id)
         require_relative 'datarow'
-        return DataRow.new(@api, {'project_id' => self.project_id, 'table_id' => self.id, 'id' => id}, false)
+        return DataRow.new(@api, {'project_id' => self.project_id, 'table_id' => self.id, 'row_id' => row_id}, false)
+    end
+
+    #
+    # Queries views of this data table.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #     
+    #     - name
+    #         * Filter views 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 500)
+    #         * Default: 50
+    #     
+    #     - offset (int)
+    #         * Number of items to skip from beginning of result set
+    #         * Default: 0
+    #   
+    # Returns:
+    #     Telerivet::APICursor (of Telerivet::DataView)
+    #
+    def query_views(options = nil)
+        require_relative 'dataview'
+        @api.cursor(DataView, get_base_api_path() + "/views", options)
+    end
+
+    #
+    # Creates a new view of this data table, defined by a filter on its rows. The view's filter
+    # conditions cannot be changed after the view is created (although the view can be renamed or
+    # deleted).
+    # 
+    # Telerivet will automatically store the count of rows matching each
+    # data view once a day, making it possible to retrieve historical statistics for the number of
+    # rows matching the filter, but only for dates after the view is created.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - name (string, max 64 characters)
+    #         * Name of the view (must be unique within the data table)
+    #         * Required
+    #     
+    #     - filters (Hash)
+    #         * Key-value pairs of conditions that rows must match to be included in the view. To
+    #             filter by a custom variable, precede the variable name with 'vars.' (conditions on
+    #             custom variables may also be provided as a nested object under a `vars` key, e.g.
+    #             `{"vars": {"q1": "yes"}}`); other supported keys are `id`, `time_created`,
+    #             `time_updated`, `contact_id`, `contact_name`, and `from_number`. Each value is
+    #             either a value to match exactly, or an object with an operator such as `ne`,
+    #             `prefix`, `gte`, `gt`, `lte`, `lt`, `exists`, or `not_exists` as the key (e.g.
+    #             `{"gte": 10}`).
+    #         * Required
+    #   
+    # Returns:
+    #     Telerivet::DataView
+    #
+    def create_view(options)
+        require_relative 'dataview'
+        DataView.new(@api, @api.do_request("POST", get_base_api_path() + "/views", options))
+    end
+
+    #
+    # Retrieves the view of the given table with the given ID.
+    # 
+    # Arguments:
+    #   - view_id
+    #       * ID of the view
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::DataView
+    #
+    def get_view_by_id(view_id)
+        require_relative 'dataview'
+        DataView.new(@api, @api.do_request("GET", get_base_api_path() + "/views/#{view_id}"))
+    end
+
+    #
+    # Initializes the view of the given table with the given ID, without making an API request.
+    # 
+    # Arguments:
+    #   - view_id
+    #       * ID of the view
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::DataView
+    #
+    def init_view_by_id(view_id)
+        require_relative 'dataview'
+        return DataView.new(@api, {'project_id' => self.project_id, 'table_id' => self.id, 'view_id' => view_id}, false)
     end
 
     #
@@ -198,9 +343,9 @@ class DataTable < Entity
     #     
     #     - items (array)
     #         * Array of up to 100 objects containing `value` and `label` string properties to
-    #             show in the dropdown list when type is `select`. Each `value` and `label` must be
-    #             between 1 and 256 characters in length.
-    #         * Required if type is `select`
+    #             show when type is `select` or `radio`. Each `value` and `label` must be between 1
+    #             and 256 characters in length.
+    #         * Required if type is `select` or `radio`
     #     
     #     - readonly (bool)
     #         * Set to true to prevent editing the field in the Telerivet web app
@@ -216,6 +361,31 @@ class DataTable < Entity
         return @api.do_request("POST", get_base_api_path() + "/fields/#{variable}", options)
     end
 
+    #
+    # Updates metadata for one or more fields (columns) in the data table. Only the specified
+    # fields are updated; other fields are not affected.
+    # 
+    # To delete a field, include an object with the `variable` and
+    # `delete` properties set (e.g. `{"variable": "my_field", "delete": true}`). Deleting a field
+    # will also clear the corresponding variable on all rows in the table.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - metadata (array)
+    #         * Array of up to 100 objects describing the fields to create, update, or delete.
+    #             Each object must contain a `variable` property. Only the properties provided for
+    #             each field will be updated.
+    #         * Required
+    #   
+    # Returns:
+    #     array
+    #
+    def update_fields(options)
+        return @api.do_request("POST", get_base_api_path() + "/fields", options)
+    end
+
     #
     # Returns the number of rows for each value of a given variable. This can be used to get the
     # total number of responses for each choice in a poll, without making a separate query for
@@ -292,6 +462,10 @@ class DataTable < Entity
         get('project_id')
     end
 
+    def url
+        get('url')
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/tables/#{get('id')}"
     end

data/lib/telerivet/dataview.rb

@@ -0,0 +1,132 @@
+
+module Telerivet
+
+#
+# Represents a view of a data table, defined by a saved filter on the table's rows.
+# 
+# The view's filter conditions cannot be changed after the view is created
+# (although the view can be renamed or deleted).
+# 
+# Telerivet will automatically store the count of rows matching each data view
+# once a day, making it possible to retrieve historical statistics for the number of rows
+# matching the filter.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the data view
+#       * Read-only
+#   
+#   - name
+#       * Name of the data view
+#       * Updatable via API
+#   
+#   - num_rows (int)
+#       * Number of rows matching the view filter. For performance reasons, this number may
+#           sometimes be out-of-date.
+#       * Read-only
+#   
+#   - filters (Hash)
+#       * Key-value pairs of conditions that rows must match to be included in the view, in
+#           the same format as the `filters` parameter of
+#           [table.createView](#DataTable.createView)
+#       * Read-only
+#   
+#   - table_id
+#       * ID of the table this view belongs to
+#       * Read-only
+#   
+#   - project_id
+#       * ID of the project this view belongs to
+#       * Read-only
+#   
+#   - url
+#       * URL to this view in the Telerivet web app
+#       * Read-only
+#
+class DataView < Entity
+    #
+    # Queries rows matching this view's filter conditions.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #     
+    #     - 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 500)
+    #         * Default: 50
+    #     
+    #     - offset (int)
+    #         * Number of items to skip from beginning of result set
+    #         * Default: 0
+    #   
+    # Returns:
+    #     Telerivet::APICursor (of Telerivet::DataRow)
+    #
+    def query_rows(options = nil)
+        require_relative 'datarow'
+        @api.cursor(DataRow, get_base_api_path() + "/rows", options)
+    end
+
+    #
+    # Saves any fields that have changed for this view.
+    #
+    def save()
+        super
+    end
+
+    #
+    # Permanently deletes the given view of a data table (does not delete any rows in the table)
+    #
+    def delete()
+        @api.do_request("DELETE", get_base_api_path())
+    end
+
+    def id
+        get('id')
+    end
+
+    def name
+        get('name')
+    end
+
+    def name=(value)
+        set('name', value)
+    end
+
+    def num_rows
+        get('num_rows')
+    end
+
+    def filters
+        get('filters')
+    end
+
+    def table_id
+        get('table_id')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def url
+        get('url')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/tables/#{get('table_id')}/views/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet/entity.rb

@@ -51,17 +51,17 @@ class Entity
         @dirty[name] = value
     end
     
-    def save()    
+    def save()
         dirty_props = @dirty
 
         if @vars != nil
             dirty_vars = @vars.get_dirty_variables()
             @dirty['vars'] = dirty_vars if dirty_vars.length() > 0
         end
-            
+
         @api.do_request('POST', get_base_api_path(), @dirty)
         @dirty = {}
-        
+
         @vars.clear_dirty_variables() if @vars != nil
     end
     

data/lib/telerivet/group.rb

@@ -18,6 +18,22 @@ module Telerivet
 #       * Whether this is a dynamic or normal group
 #       * Read-only
 #   
+#   - filters (Hash)
+#       * Key-value pairs of conditions that contacts must match to be members of a dynamic
+#           group. To filter by a custom variable, precede the variable name with 'vars.'
+#           (conditions on custom variables may also be provided as a nested object under a `vars`
+#           key, e.g. `{"vars": {"city": "Manila"}}`); other supported keys are `id`, `name`,
+#           `phone_number`, `time_created`, `time_updated`, `incoming_message_count`,
+#           `outgoing_message_count`, `last_incoming_message_time`, `last_outgoing_message_time`,
+#           `conversation_status`, `send_blocked`, `group` (ID of a normal group whose members
+#           should be included), `not_group` (ID of a normal group whose members should be
+#           excluded), and `q` (full-text search query matching contacts like the search box in
+#           the web app). Each value is either a value to match exactly, or an object with an
+#           operator such as `ne`, `prefix`, `gte`, `lt`, `exists`, or `not_exists` as the key
+#           (e.g. `{"gte": 10}`). Null if this is a normal group. Filter conditions can only be
+#           updated on dynamic groups.
+#       * Updatable via API
+#   
 #   - num_members (int)
 #       * Number of contacts in the group (null if the group is dynamic)
 #       * Read-only
@@ -45,6 +61,10 @@ module Telerivet
 #           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
+#   - url
+#       * URL to this group in the Telerivet web app
+#       * Read-only
+#   
 #   - project_id
 #       * ID of the project this group belongs to
 #       * Read-only
@@ -208,6 +228,14 @@ class Group < Entity
         get('dynamic')
     end
 
+    def filters
+        get('filters')
+    end
+
+    def filters=(value)
+        set('filters', value)
+    end
+
     def num_members
         get('num_members')
     end
@@ -232,6 +260,10 @@ class Group < Entity
         set('add_time_variable', value)
     end
 
+    def url
+        get('url')
+    end
+
     def project_id
         get('project_id')
     end

data/lib/telerivet/label.rb

@@ -49,7 +49,7 @@ class Label < Entity
     #     - source
     #         * Filter messages by source
     #         * Allowed values: phone, provider, web, api, service, webhook, scheduled,
-    #             integration
+    #             integration, mcp
     #     
     #     - starred (bool)
     #         * Filter messages by starred/unstarred

data/lib/telerivet/message.rb

@@ -28,7 +28,8 @@ module Telerivet
 #   
 #   - source
 #       * How the message originated within Telerivet
-#       * Allowed values: phone, provider, web, api, service, webhook, scheduled, integration
+#       * Allowed values: phone, provider, web, api, service, webhook, scheduled, integration,
+#           mcp
 #       * Read-only
 #   
 #   - time_created (UNIX timestamp)
@@ -179,11 +180,8 @@ module Telerivet
 #       * 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.
+#       * Array of media attachments for the text message. This property is undefined for
+#           messages that do not contain media files.
 #       * Read-only
 #   
 #   - mms_parts (array)
@@ -245,6 +243,10 @@ module Telerivet
 #   - project_id
 #       * ID of the project this contact belongs to
 #       * Read-only
+#   
+#   - url
+#       * URL to the message detail page in the Telerivet web app
+#       * Read-only
 #
 class Message < Entity
 
@@ -347,6 +349,22 @@ class Message < Entity
         Message.new(@api, @api.do_request("POST", get_base_api_path() + "/cancel"))
     end
 
+    #
+    # Sends a read receipt for this message. Currently only supported for incoming WhatsApp
+    # messages.
+    #
+    def send_read_receipt()
+        @api.do_request("POST", get_base_api_path() + "/send_read_receipt")
+    end
+
+    #
+    # Sends a typing indicator for this message. Currently only supported for incoming WhatsApp
+    # messages.
+    #
+    def send_typing_indicator()
+        @api.do_request("POST", get_base_api_path() + "/send_typing_indicator")
+    end
+
     #
     # Deletes this message.
     #
@@ -530,6 +548,10 @@ class Message < Entity
         get('project_id')
     end
 
+    def url
+        get('url')
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/messages/#{get('id')}"
     end