telerivet 1.4.6 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b442bc6d2aab45f4be47acc976f991bbd399de9a68ac092ec6dd2d717c3373e9
-  data.tar.gz: 7c629053a6f168be87bb4e705e6cad78c9e7ec3aebe34cbb7553843dcf0cb02b
+  metadata.gz: 4e063e2ce507f6d45b86d12c584475887c050c3d439863d91d545b0ba331e823
+  data.tar.gz: d8040eb663854c7df190aa8f49984d9854687238532b6278af53dea6ebc77250
 SHA512:
-  metadata.gz: b2585a9e281177331fe9615cbf02d91169f5f6bb178ebe228cd81b4def87576a7486b4e5457261b324f6fe1b958bace906e2e3a28d5b9bef8cb7c77f09bc9586
-  data.tar.gz: 35cb63dc5fbcdb5400808a8f3c4db85e4e5b07d85bd273c01d4693975ae10682e758a67e92797b7e771ccaba6fcd573e3629389aed7696346eff142da6186ef7
+  metadata.gz: da5e09e1c639a5e1bd3b704214c4a276d62469e6ae0853d71cbe4b9dc2a2aacbb1f58d5e5bcbf1093e5cbf24a7a99abcf30d029883aca055d4b41ae9f3a7f8ff
+  data.tar.gz: 4ad80ced036f9d8810e3e7f693443247740791ed4097b26ce179c2c2ef0ca06986b41942fde40401ea8989df19591f84834439efb74900f9bb57ec7f939d8f25

data/lib/telerivet.rb

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

data/lib/telerivet/airtimetransaction.rb

@@ -65,6 +65,10 @@ module Telerivet
 #       * ID of the project that the airtime transaction belongs to
 #       * Read-only
 #   
+#   - external_id
+#       * The ID of this transaction from an external airtime gateway provider, if available.
+#       * Read-only
+#   
 #   - vars (Hash)
 #       * Custom variables stored for this transaction
 #       * Updatable via API
@@ -122,6 +126,10 @@ class AirtimeTransaction < Entity
         get('project_id')
     end
 
+    def external_id
+        get('external_id')
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/airtime_transactions/#{get('id')}"
     end

data/lib/telerivet/contact.rb

@@ -253,8 +253,8 @@ class Contact < Entity
     #     
     #     - next_time (UNIX timestamp)
     #         * Filter scheduled messages by next_time
-    #         * Allowed modifiers: next_time[exists], next_time[ne], next_time[min],
-    #             next_time[max]
+    #         * Allowed modifiers: next_time[ne], next_time[min], next_time[max],
+    #             next_time[exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -331,9 +331,9 @@ class Contact < Entity
     #     
     #     - vars (Hash)
     #         * Filter states by value of a custom variable (e.g. vars[email], vars[foo], etc.)
-    #         * Allowed modifiers: vars[foo][exists], vars[foo][ne], vars[foo][prefix],
-    #             vars[foo][not_prefix], vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte],
-    #             vars[foo][min], vars[foo][max]
+    #         * Allowed modifiers: vars[foo][ne], vars[foo][prefix], vars[foo][not_prefix],
+    #             vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte], vars[foo][min],
+    #             vars[foo][max], vars[foo][exists]
     #     
     #     - sort
     #         * Sort the results based on a field

data/lib/telerivet/datatable.rb

@@ -22,7 +22,8 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - num_rows (int)
-#       * Number of rows in the table
+#       * Number of rows in the table. For performance reasons, this number may sometimes be
+#           out-of-date.
 #       * Read-only
 #   
 #   - show_add_row (bool)
@@ -61,9 +62,9 @@ class DataTable < Entity
     #     
     #     - vars (Hash)
     #         * Filter data rows by value of a custom variable (e.g. vars[q1], vars[foo], etc.)
-    #         * Allowed modifiers: vars[foo][exists], vars[foo][ne], vars[foo][prefix],
-    #             vars[foo][not_prefix], vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte],
-    #             vars[foo][min], vars[foo][max]
+    #         * Allowed modifiers: vars[foo][ne], vars[foo][prefix], vars[foo][not_prefix],
+    #             vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte], vars[foo][min],
+    #             vars[foo][max], vars[foo][exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -175,7 +176,7 @@ class DataTable < Entity
     #     - type (string)
     #         * Field type
     #         * Allowed values: text, long_text, number, boolean, email, url, audio, phone_number,
-    #             date, date_time, groups, route, select, buttons
+    #             date, date_time, groups, route, select, buttons, contact
     #     
     #     - order (int)
     #         * Order in which to display the field

data/lib/telerivet/group.rb

@@ -50,7 +50,7 @@ class Group < Entity
     #         * Filter contacts by 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]
+    #             phone_number[lte], phone_number[exists]
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter contacts by time created
@@ -58,20 +58,20 @@ class Group < Entity
     #     
     #     - last_message_time (UNIX timestamp)
     #         * Filter contacts by last time a message was sent or received
-    #         * Allowed modifiers: last_message_time[exists], last_message_time[ne],
-    #             last_message_time[min], last_message_time[max]
+    #         * Allowed modifiers: last_message_time[ne], last_message_time[min],
+    #             last_message_time[max], last_message_time[exists]
     #     
     #     - last_incoming_message_time (UNIX timestamp)
     #         * Filter contacts by last time a message was received
-    #         * Allowed modifiers: last_incoming_message_time[exists],
-    #             last_incoming_message_time[ne], last_incoming_message_time[min],
-    #             last_incoming_message_time[max]
+    #         * Allowed modifiers: last_incoming_message_time[ne],
+    #             last_incoming_message_time[min], last_incoming_message_time[max],
+    #             last_incoming_message_time[exists]
     #     
     #     - last_outgoing_message_time (UNIX timestamp)
     #         * Filter contacts by last time a message was sent
-    #         * Allowed modifiers: last_outgoing_message_time[exists],
-    #             last_outgoing_message_time[ne], last_outgoing_message_time[min],
-    #             last_outgoing_message_time[max]
+    #         * Allowed modifiers: last_outgoing_message_time[ne],
+    #             last_outgoing_message_time[min], last_outgoing_message_time[max],
+    #             last_outgoing_message_time[exists]
     #     
     #     - incoming_message_count (int)
     #         * Filter contacts by number of messages received from the contact
@@ -88,9 +88,9 @@ class Group < Entity
     #     
     #     - vars (Hash)
     #         * Filter contacts by value of a custom variable (e.g. vars[email], vars[foo], etc.)
-    #         * Allowed modifiers: vars[foo][exists], vars[foo][ne], vars[foo][prefix],
-    #             vars[foo][not_prefix], vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte],
-    #             vars[foo][min], vars[foo][max]
+    #         * Allowed modifiers: vars[foo][ne], vars[foo][prefix], vars[foo][not_prefix],
+    #             vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte], vars[foo][min],
+    #             vars[foo][max], vars[foo][exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -134,8 +134,8 @@ class Group < Entity
     #     
     #     - next_time (UNIX timestamp)
     #         * Filter scheduled messages by next_time
-    #         * Allowed modifiers: next_time[exists], next_time[ne], next_time[min],
-    #             next_time[max]
+    #         * Allowed modifiers: next_time[ne], next_time[min], next_time[max],
+    #             next_time[exists]
     #     
     #     - sort
     #         * Sort the results based on a field

data/lib/telerivet/project.rb

@@ -648,6 +648,9 @@ class Project < Entity
     # Arguments:
     #   - options (Hash)
     #     
+    #     - group_id
+    #         * Filter contacts within a group
+    #     
     #     - name
     #         * Filter contacts by name
     #         * Allowed modifiers: name[ne], name[prefix], name[not_prefix], name[gte], name[gt],
@@ -657,7 +660,7 @@ class Project < Entity
     #         * Filter contacts by 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]
+    #             phone_number[lte], phone_number[exists]
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter contacts by time created
@@ -665,20 +668,20 @@ class Project < Entity
     #     
     #     - last_message_time (UNIX timestamp)
     #         * Filter contacts by last time a message was sent or received
-    #         * Allowed modifiers: last_message_time[exists], last_message_time[ne],
-    #             last_message_time[min], last_message_time[max]
+    #         * Allowed modifiers: last_message_time[ne], last_message_time[min],
+    #             last_message_time[max], last_message_time[exists]
     #     
     #     - last_incoming_message_time (UNIX timestamp)
     #         * Filter contacts by last time a message was received
-    #         * Allowed modifiers: last_incoming_message_time[exists],
-    #             last_incoming_message_time[ne], last_incoming_message_time[min],
-    #             last_incoming_message_time[max]
+    #         * Allowed modifiers: last_incoming_message_time[ne],
+    #             last_incoming_message_time[min], last_incoming_message_time[max],
+    #             last_incoming_message_time[exists]
     #     
     #     - last_outgoing_message_time (UNIX timestamp)
     #         * Filter contacts by last time a message was sent
-    #         * Allowed modifiers: last_outgoing_message_time[exists],
-    #             last_outgoing_message_time[ne], last_outgoing_message_time[min],
-    #             last_outgoing_message_time[max]
+    #         * Allowed modifiers: last_outgoing_message_time[ne],
+    #             last_outgoing_message_time[min], last_outgoing_message_time[max],
+    #             last_outgoing_message_time[exists]
     #     
     #     - incoming_message_count (int)
     #         * Filter contacts by number of messages received from the contact
@@ -695,9 +698,9 @@ class Project < Entity
     #     
     #     - vars (Hash)
     #         * Filter contacts by value of a custom variable (e.g. vars[email], vars[foo], etc.)
-    #         * Allowed modifiers: vars[foo][exists], vars[foo][ne], vars[foo][prefix],
-    #             vars[foo][not_prefix], vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte],
-    #             vars[foo][min], vars[foo][max]
+    #         * Allowed modifiers: vars[foo][ne], vars[foo][prefix], vars[foo][not_prefix],
+    #             vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte], vars[foo][min],
+    #             vars[foo][max], vars[foo][exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -776,8 +779,8 @@ class Project < Entity
     #     
     #     - last_active_time (UNIX timestamp)
     #         * Filter phones by last active time
-    #         * Allowed modifiers: last_active_time[exists], last_active_time[ne],
-    #             last_active_time[min], last_active_time[max]
+    #         * Allowed modifiers: last_active_time[ne], last_active_time[min],
+    #             last_active_time[max], last_active_time[exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -843,6 +846,9 @@ class Project < Entity
     # Arguments:
     #   - options (Hash)
     #     
+    #     - label_id
+    #         * Filter messages with a label
+    #     
     #     - direction
     #         * Filter messages by direction
     #         * Allowed values: incoming, outgoing
@@ -1019,6 +1025,290 @@ class Project < Entity
         return Broadcast.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
 
+    #
+    # Creates and starts an asynchronous task that is applied to all entities matching a filter
+    # (e.g. contacts, messages, or data rows).
+    # Tasks are designed to efficiently process a large number of
+    # entities. When processing a large number of entities,
+    # tasks are much faster than using the API to query and loop over
+    # all objects matching a filter.
+    # 
+    # Several different types of tasks are supported, including
+    # applying services to contacts, messages, or data rows;
+    # adding or removing contacts from a group; blocking or unblocking
+    # sending messages to a contact; updating a custom variable;
+    # deleting contacts, messages, or data rows; or exporting data to
+    # CSV.
+    # 
+    # When using a task to apply a Custom Actions or Cloud Script API
+    # service (`apply_service_to_contacts`, `apply_service_to_rows`, or
+    # `apply_service_to_messages`),
+    # the `task` variable will be available within the service. The
+    # service can use custom variables on the task object (e.g. `task.vars.example`), such as
+    # to store aggregate statistics for the rows matching the filter.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - task_type
+    #         * Type of task to create. Each `task_type` applies to a certain type of entity (such
+    #             as a contact, message, or data row).
+    #             
+    #             Tasks for contacts:
+    #             
+    #             - `update_contact_var`
+    #             - `add_group_members`
+    #             - `remove_group_members`
+    #             - `set_conversation_status`
+    #             - `set_send_blocked`
+    #             - `apply_service_to_contacts`
+    #             - `delete_contacts`
+    #             - `export_contacts`
+    #             
+    #             Tasks for data rows:
+    #             
+    #             - `update_row_var`
+    #             - `apply_service_to_rows`
+    #             - `delete_rows`
+    #             - `export_rows`
+    #             
+    #             Tasks for messages:
+    #             
+    #             - `cancel_messages`
+    #             - `resend_messages`
+    #             - `retry_message_services`
+    #             - `apply_service_to_messages`
+    #             - `add_label`
+    #             - `remove_label`
+    #             - `update_message_var`
+    #             - `delete_messages`
+    #             - `export_messages`
+    #         * Allowed values: update_contact_var, delete_contacts, add_group_members,
+    #             remove_group_members, set_conversation_status, set_send_blocked,
+    #             apply_service_to_contacts, update_row_var, delete_rows, apply_service_to_rows,
+    #             delete_messages, cancel_messages, resend_messages, retry_message_services,
+    #             apply_service_to_messages, add_label, remove_label, update_message_var,
+    #             export_messages, export_contacts, export_rows
+    #         * Required
+    #     
+    #     - task_params (Hash)
+    #         * Parameters applied to all matching rows (specific to `task_type`).
+    #             
+    #             **`apply_service_to_contacts`**,
+    #             **`apply_service_to_messages`**, **`apply_service_to_rows`**:
+    #             <table>
+    #             <tr><td> `service_id` </td> <td> The ID of the
+    #             service to apply (string) </td></tr>
+    #             </table>
+    #             
+    #             **`update_contact_var`**, **`update_message_var`**,
+    #             **`update_row_var`**:
+    #             <table>
+    #             <tr><td> `variable` </td> <td> The custom variable
+    #             name (string) </td></tr>
+    #             <tr><td> `value` </td> <td> The value to set
+    #             (string, boolean, float, null) </td></tr>
+    #             </table>
+    #             
+    #             **`add_group_members`**, **`remove_group_members`**:
+    #             <table>
+    #             <tr><td> `group_id` </td> <td> The ID of the group
+    #             (string) </td></tr>
+    #             </table>
+    #             
+    #             **`add_label`**, **`remove_label`**:
+    #             <table>
+    #             <tr><td> `label_id` </td> <td> The ID of the label
+    #             (string) </td></tr>
+    #             </table>
+    #             
+    #             **`resend_messages`**:
+    #             <table>
+    #             <tr><td> `route_id` </td> <td> ID of the new route
+    #             to use, or null to use the original route (string) </td></tr>
+    #             </table>
+    #             
+    #             **`set_send_blocked`**:
+    #             <table>
+    #             <tr><td> `send_blocked` </td> <td> `true` to block
+    #             sending messages, `false` to unblock sending messages (boolean) </td></tr>
+    #             </table>
+    #             
+    #             **`set_conversation_status`**:
+    #             <table>
+    #             <tr><td> `conversation_status` </td> <td> "active",
+    #             "handled", or "closed" (string) </td></tr>
+    #             </table>
+    #             
+    #             **`export_contacts`**, **`export_messages`**,
+    #             **`export_rows`**:
+    #             <table>
+    #             <tr><td>`storage_id` </td> <td> ID of a storage
+    #             backend where the CSV file will be saved. (string)
+    #             
+    #             Currently only AWS S3 is supported as a storage
+    #             backend.
+    #             This requires creating a S3 bucket in your own
+    #             AWS account, as well as an IAM user with access key and secret that has permission
+    #             to write to that bucket.
+    #             To configure your own S3 bucket as a storage
+    #             backend, contact support.
+    #             
+    #             Direct downloads are not supported when
+    #             exporting data via the API.
+    #             (string) </td></tr>
+    #             <tr><td>`filename` </td> <td> Path within the
+    #             storage backend where the CSV file will be saved </td></tr>
+    #             <tr><td>`column_ids` </td> <td> IDs of columns to
+    #             save in the CSV file. If not provided, all default columns will be saved. (array of
+    #             strings, optional) </td></tr>
+    #             </table>
+    #             
+    #             **`delete_contacts`**, **`delete_messages`**,
+    #             **`delete_rows`**, **`cancel_messages`**, **`retry_message_services`**: <br />
+    #             No parameters.
+    #     
+    #     - filter_type
+    #         * Type of filter defining the rows that the task is applied to.
+    #             
+    #             Each `filter_type` queries a certain type of
+    #             entity (such as contacts, messages, or data rows).
+    #             
+    #             In general, the `task_type` and the
+    #             `filter_type` must return the same type of entity; however, tasks applied to
+    #             contacts (other than `export_contacts`) can also be applied
+    #             when the filter returns entities that are
+    #             associated with a contact, such as messages or data rows. (Note that in this case,
+    #             it is possible for the task to be applied multiple times to an individual contact if
+    #             multiple messages or data rows are associated with the same contact.)
+    #         * Allowed values: query_contacts, contact_ids, query_rows, row_ids, query_messages,
+    #             message_ids
+    #         * Required
+    #     
+    #     - filter_params (Hash)
+    #         * Parameters defining the rows that the task is applied to (specific to
+    #             `filter_type`).
+    #             
+    #             **`query_contacts`**: <br />
+    #             The same filter parameters as used by
+    #             [project.queryContacts](#Project.queryContacts). If you want to apply the task to
+    #             all contacts, use the parameters {"all": true}.
+    #             
+    #             **`contact_ids`**:
+    #             <table>
+    #             <tr><td> `contact_ids` </td> <td> IDs of up to 100
+    #             contacts to apply this task to (array of strings) </td></tr>
+    #             </table>
+    #             
+    #             **`query_messages`**: <br />
+    #             The same filter parameters as used by
+    #             [project.queryMessages](#Project.queryMessages). If you want to apply the task to
+    #             all messages, use the parameters {"all": true}.
+    #             
+    #             **`message_ids`**:
+    #             <table>
+    #             <tr><td> `message_ids` </td> <td> IDs of up to 100
+    #             messages to apply this task to (array of strings) </td></tr>
+    #             </table>
+    #             
+    #             **`query_rows`**: <br />
+    #             The same filter parameters as used by
+    #             [table.queryRows](#DataTable.queryRows). If you want to apply the task to all rows
+    #             in the table, use the parameters {"all": true}.
+    #             
+    #             **`row_ids`**:
+    #             <table>
+    #             <tr><td> `row_ids` </td> <td> IDs of up to 100 data
+    #             rows to apply this task to (array of strings) </td></tr>
+    #             </table>
+    #         * Required
+    #     
+    #     - table_id (string, max 34 characters)
+    #         * ID of the data table this task is applied to (if applicable).
+    #             
+    #             Required if filter_type is `query_rows` or `row_ids`.
+    #     
+    #     - vars (Hash)
+    #         * Initial custom variables to set for the task.
+    #             
+    #             If the task applies a service, the service can read
+    #             and write custom variables on the task object (e.g. `task.vars.example`), such as
+    #             to store aggregate statistics for the rows matching
+    #             the filter.
+    #   
+    # Returns:
+    #     Telerivet::Task
+    #
+    def create_task(options)
+        require_relative 'task'
+        Task.new(@api, @api.do_request("POST", get_base_api_path() + "/tasks", options))
+    end
+
+    #
+    # Queries batch tasks within the given project.
+    # 
+    # 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::Task)
+    #
+    def query_tasks(options = nil)
+        require_relative 'task'
+        @api.cursor(Task, get_base_api_path() + "/tasks", options)
+    end
+
+    #
+    # Retrieves the task with the given ID.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the task
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Task
+    #
+    def get_task_by_id(id)
+        require_relative 'task'
+        Task.new(@api, @api.do_request("GET", get_base_api_path() + "/tasks/#{id}"))
+    end
+
+    #
+    # Initializes the task with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the task
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Task
+    #
+    def init_task_by_id(id)
+        require_relative 'task'
+        return Task.new(@api, {'project_id' => self.id, 'id' => id}, false)
+    end
+
     #
     # Queries groups within the given project.
     # 
@@ -1293,8 +1583,8 @@ class Project < Entity
     #     
     #     - next_time (UNIX timestamp)
     #         * Filter scheduled messages by next_time
-    #         * Allowed modifiers: next_time[exists], next_time[ne], next_time[min],
-    #             next_time[max]
+    #         * Allowed modifiers: next_time[ne], next_time[min], next_time[max],
+    #             next_time[exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -1370,7 +1660,7 @@ class Project < Entity
     #     
     #     - context
     #         * Filter services that can be invoked in a particular context
-    #         * Allowed values: message, call, contact, project
+    #         * Allowed values: message, call, ussd_session, row, contact, project
     #     
     #     - sort
     #         * Sort the results based on a field

data/lib/telerivet/service.rb

@@ -97,7 +97,7 @@ class Service < Entity
     #     
     #     - context
     #         * The name of the context in which this service is invoked
-    #         * Allowed values: message, call, contact, project
+    #         * Allowed values: message, call, ussd_session, row, contact, project
     #         * Required
     #     
     #     - event
@@ -120,24 +120,29 @@ class Service < Entity
     #     - route_id
     #         * The ID of the phone or route that the service will use for sending messages by
     #             default
+    #     
+    #     - async (bool)
+    #         * If set to true, the service will be invoked asynchronously. By default, queued
+    #             services will be invoked one at a time for each project.
     #   
     # Returns:
     #     (associative array)
     #       - return_value (any)
     #           * Return value of the service. May be any JSON type (boolean, number, string,
-    #               array, object, or null).
+    #               array, object, or null). (Undefined if async=true.)
     #       
     #       - log_entries (array)
-    #           * Array of log entry strings generated by the service
+    #           * Array of log entry strings generated by the service. (Undefined if async=true.)
     #       
     #       - errors (array)
-    #           * Array of error message strings generated by the service
+    #           * Array of error message strings generated by the service. (Undefined if
+    #               async=true.)
     #       
     #       - sent_messages (array of objects)
-    #           * Array of messages sent by the service
+    #           * Array of messages sent by the service (Undefined if async=true.)
     #       
     #       - airtime_transactions (array of objects)
-    #           * Array of airtime transactions sent by the service
+    #           * Array of airtime transactions sent by the service (Undefined if async=true.)
     #
     def invoke(options)        
         invoke_result = @api.do_request('POST', get_base_api_path() + '/invoke', options)
@@ -234,9 +239,9 @@ class Service < Entity
     #     
     #     - vars (Hash)
     #         * Filter states by value of a custom variable (e.g. vars[email], vars[foo], etc.)
-    #         * Allowed modifiers: vars[foo][exists], vars[foo][ne], vars[foo][prefix],
-    #             vars[foo][not_prefix], vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte],
-    #             vars[foo][min], vars[foo][max]
+    #         * Allowed modifiers: vars[foo][ne], vars[foo][prefix], vars[foo][not_prefix],
+    #             vars[foo][gte], vars[foo][gt], vars[foo][lt], vars[foo][lte], vars[foo][min],
+    #             vars[foo][max], vars[foo][exists]
     #     
     #     - sort
     #         * Sort the results based on a field

data/lib/telerivet/task.rb

@@ -0,0 +1,151 @@
+
+module Telerivet
+
+#
+# Represents an asynchronous task that is applied to all entities matching a filter.
+# 
+# Tasks include services applied to contacts, messages, or data rows; adding
+# or removing contacts from a group; blocking or unblocking sending messages to a contact;
+# updating a custom variable; deleting contacts, messages, or data rows; or
+# exporting data to CSV.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the task
+#       * Read-only
+#   
+#   - task_type (string)
+#       * The task type
+#       * Read-only
+#   
+#   - task_params (Hash)
+#       * Parameters applied to all matching rows (specific to `task_type`). See
+#           [project.createTask](#Project.createTask).
+#       * Read-only
+#   
+#   - filter_type
+#       * Type of filter defining the rows that the task is applied to
+#       * Read-only
+#   
+#   - filter_params (Hash)
+#       * Parameters defining the rows that the task is applied to (specific to
+#           `filter_type`). See [project.createTask](#Project.createTask).
+#       * Read-only
+#   
+#   - time_created (UNIX timestamp)
+#       * Time the task was created in Telerivet
+#       * Read-only
+#   
+#   - time_active (UNIX timestamp)
+#       * Time Telerivet started executing the task
+#       * Read-only
+#   
+#   - time_complete (UNIX timestamp)
+#       * Time Telerivet finished executing the task
+#       * Read-only
+#   
+#   - total_rows (int)
+#       * The total number of rows matching the filter (null if not known)
+#       * Read-only
+#   
+#   - current_row (int)
+#       * The number of rows that have been processed so far
+#       * Read-only
+#   
+#   - status (string)
+#       * The current status of the task
+#       * Allowed values: created, queued, active, complete, failed, cancelled
+#       * Read-only
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this task
+#       * Read-only
+#   
+#   - table_id (string, max 34 characters)
+#       * ID of the data table this task is applied to (if applicable)
+#       * Read-only
+#   
+#   - user_id (string, max 34 characters)
+#       * ID of the Telerivet user who created the task (if applicable)
+#       * Read-only
+#   
+#   - project_id
+#       * ID of the project this task belongs to
+#       * Read-only
+#
+class Task < Entity
+    #
+    # Cancels a task that is not yet complete.
+    # 
+    # Returns:
+    #     Telerivet::Task
+    #
+    def cancel()
+        require_relative 'task'
+        Task.new(@api, @api.do_request("POST", get_base_api_path() + "/cancel"))
+    end
+
+    def id
+        get('id')
+    end
+
+    def task_type
+        get('task_type')
+    end
+
+    def task_params
+        get('task_params')
+    end
+
+    def filter_type
+        get('filter_type')
+    end
+
+    def filter_params
+        get('filter_params')
+    end
+
+    def time_created
+        get('time_created')
+    end
+
+    def time_active
+        get('time_active')
+    end
+
+    def time_complete
+        get('time_complete')
+    end
+
+    def total_rows
+        get('total_rows')
+    end
+
+    def current_row
+        get('current_row')
+    end
+
+    def status
+        get('status')
+    end
+
+    def table_id
+        get('table_id')
+    end
+
+    def user_id
+        get('user_id')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/tasks/#{get('id')}"
+    end
+ 
+end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerivet
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: 1.5.0
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2021-03-27 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com
@@ -35,6 +35,7 @@ files:
 - lib/telerivet/route.rb
 - lib/telerivet/scheduledmessage.rb
 - lib/telerivet/service.rb
+- lib/telerivet/task.rb
 homepage: http://telerivet.com
 licenses:
 - MIT