telerivet 1.4.5 → 1.6.1

data/lib/telerivet/project.rb

@@ -82,11 +82,31 @@ class Project < Entity
     #             short URLs.
     #         * Default: false
     #     
+    #     - short_link_params (Hash)
+    #         *
+    #             If `track_clicks` is true, `short_link_params` may be used to specify
+    #             custom parameters for each short link in the message. The following parameters are
+    #             supported:
+    #             
+    #             `domain` (string): A custom short domain name to use for the short
+    #             links. The domain name must already be registered for your project or organization.
+    #             
+    #             `expiration_sec` (integer): The number of seconds after the message is
+    #             created (queued to send) when the short links will stop forwarding to the
+    #             destination URL.
+    #             If null, the short links will not expire.
+    #     
     #     - media_urls (array)
     #         * URLs of media files to attach to the text message. If `message_type` is `sms`,
     #             short links to each media URL will be appended to the end of the content (separated
     #             by a new line).
     #     
+    #     - route_params (Hash)
+    #         * Route-specific parameters for the message. The parameters object should have one
+    #             or more keys matching the `phone_type` field of a phone (basic route) that may be
+    #             used to send the message. The corresponding value should be an object with
+    #             route-specific parameters to use if the message is sent by that type of route.
+    #     
     #     - label_ids (array)
     #         * List of IDs of labels to add to this message
     #     
@@ -202,6 +222,20 @@ class Project < Entity
     #             short URLs.
     #         * Default: false
     #     
+    #     - short_link_params (Hash)
+    #         *
+    #             If `track_clicks` is true, `short_link_params` may be used to specify
+    #             custom parameters for each short link in the message. The following parameters are
+    #             supported:
+    #             
+    #             `domain` (string): A custom short domain name to use for the short
+    #             links. The domain name must already be registered for your project or organization.
+    #             
+    #             `expiration_sec` (integer): The number of seconds after the message is
+    #             created (queued to send) when the short links will stop forwarding to the
+    #             destination URL.
+    #             If null, the short links will not expire.
+    #     
     #     - media_urls (array)
     #         * URLs of media files to attach to the text message. If `message_type` is `sms`,
     #             short links to each URL will be appended to the end of the content (separated by a
@@ -210,6 +244,12 @@ class Project < Entity
     #     - vars (Hash)
     #         * Custom variables to set for each message
     #     
+    #     - route_params (Hash)
+    #         * Route-specific parameters for the messages in the broadcast. The parameters object
+    #             may have keys matching the `phone_type` field of a phone (basic route) that may be
+    #             used to send messages in this broadcast. The corresponding value is an object with
+    #             route-specific parameters to use when sending messages with that type of route.
+    #     
     #     - service_id
     #         * Service to invoke for each recipient (when `message_type` is `call` or `service`)
     #         * Required if message_type is service
@@ -295,11 +335,36 @@ class Project < Entity
     #             available variables)](#variables)
     #         * Default: false
     #     
+    #     - track_clicks (boolean)
+    #         * If true, URLs in the message content will automatically be replaced with unique
+    #             short URLs.
+    #         * Default: false
+    #     
+    #     - short_link_params (Hash)
+    #         *
+    #             If `track_clicks` is true, `short_link_params` may be used to specify
+    #             custom parameters for each short link in the message. The following parameters are
+    #             supported:
+    #             
+    #             `domain` (string): A custom short domain name to use for the short
+    #             links. The domain name must already be registered for your project or organization.
+    #             
+    #             `expiration_sec` (integer): The number of seconds after the message is
+    #             created (queued to send) when the short links will stop forwarding to the
+    #             destination URL.
+    #             If null, the short links will not expire.
+    #     
     #     - media_urls (array)
     #         * URLs of media files to attach to the text message. If `message_type` is `sms`,
     #             short links to each media URL will be appended to the end of the content (separated
     #             by a new line).
     #     
+    #     - route_params (Hash)
+    #         * Route-specific parameters to apply to all messages. The parameters object may have
+    #             keys matching the `phone_type` field of a phone (basic route) that may be used to
+    #             send messages. The corresponding value is an object with route-specific parameters
+    #             to use when sending messages with that type of route.
+    #     
     #     - vars (Hash)
     #         * Custom variables to store with the message
     #     
@@ -325,6 +390,10 @@ class Project < Entity
     #               (Other properties of the Message object are
     #               omitted in order to reduce the amount of redundant data sent in each API
     #               response.)
+    #               If the `messages` parameter in the API request
+    #               contains items with `to_number` values that are associated with blocked contacts,
+    #               the `id` and `status` properties corresponding to those items will be null, and no
+    #               messages will be sent to those numbers.
     #       
     #       - broadcast_id
     #           * ID of broadcast that these messages are associated with, if `broadcast_id` or
@@ -447,6 +516,20 @@ class Project < Entity
     #             short URLs.
     #         * Default: false
     #     
+    #     - short_link_params (Hash)
+    #         *
+    #             If `track_clicks` is true, `short_link_params` may be used to specify
+    #             custom parameters for each short link in the message. The following parameters are
+    #             supported:
+    #             
+    #             `domain` (string): A custom short domain name to use for the short
+    #             links. The domain name must already be registered for your project or organization.
+    #             
+    #             `expiration_sec` (integer): The number of seconds after the message is
+    #             created (queued to send) when the short links will stop forwarding to the
+    #             destination URL.
+    #             If null, the short links will not expire.
+    #     
     #     - is_template (bool)
     #         * Set to true to evaluate variables like [[contact.name]] in message content
     #         * Default: false
@@ -456,6 +539,12 @@ class Project < Entity
     #             short links to each media URL will be appended to the end of the content (separated
     #             by a new line).
     #     
+    #     - route_params (Hash)
+    #         * Route-specific parameters to use when sending the message. The parameters object
+    #             may have keys matching the `phone_type` field of a phone (basic route) that may be
+    #             used to send the message. The corresponding value is an object with route-specific
+    #             parameters to use when sending a message with that type of route.
+    #     
     #     - label_ids (array)
     #         * Array of IDs of labels to add to the sent messages (maximum 5). Does not apply
     #             when `message_type`=`service`, since the labels are determined by the service
@@ -648,6 +737,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,28 +749,26 @@ 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
-    #         * Allowed modifiers: time_created[ne], time_created[min], time_created[max]
+    #         * Allowed modifiers: time_created[min], time_created[max]
     #     
     #     - 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[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[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[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 +785,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 +866,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[min], last_active_time[max],
+    #             last_active_time[exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -843,6 +933,9 @@ class Project < Entity
     # Arguments:
     #   - options (Hash)
     #     
+    #     - label_id
+    #         * Filter messages with a label
+    #     
     #     - direction
     #         * Filter messages by direction
     #         * Allowed values: incoming, outgoing
@@ -853,7 +946,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
@@ -861,7 +955,7 @@ class Project < Entity
     #     - status
     #         * Filter messages by status
     #         * Allowed values: ignored, processing, received, sent, queued, failed,
-    #             failed_queued, cancelled, delivered, not_delivered
+    #             failed_queued, cancelled, delivered, not_delivered, read
     #     
     #     - time_created[min] (UNIX timestamp)
     #         * Filter messages created on or after a particular time
@@ -871,18 +965,26 @@ class Project < Entity
     #     
     #     - external_id
     #         * Filter messages by ID from an external provider
+    #         * Allowed modifiers: external_id[ne], external_id[exists]
     #     
     #     - contact_id
     #         * ID of the contact who sent/received the message
+    #         * Allowed modifiers: contact_id[ne], contact_id[exists]
     #     
     #     - phone_id
     #         * ID of the phone (basic route) that sent/received the message
     #     
     #     - broadcast_id
     #         * ID of the broadcast containing the message
+    #         * Allowed modifiers: broadcast_id[ne], broadcast_id[exists]
     #     
     #     - scheduled_id
     #         * ID of the scheduled message that created this message
+    #         * Allowed modifiers: scheduled_id[ne], scheduled_id[exists]
+    #     
+    #     - group_id
+    #         * Filter messages sent or received by contacts in a particular group. The group must
+    #             be a normal group, not a dynamic group.
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -1018,6 +1120,298 @@ 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>
+    #             <tr><td> `variables` </td> <td> Optional object
+    #             containing up to 25 temporary variable names and their corresponding values to set
+    #             when invoking the service. Values may be strings, numbers, or boolean (true/false).
+    #             String values may be up to 4096 bytes in length. Arrays and objects are not
+    #             supported. Within Custom Actions, each variable can be used like [[$name]] (with a
+    #             leading $ character and surrounded by double square brackets). Within a Cloud Script
+    #             API service or JavaScript action, each variable will be available as a global
+    #             JavaScript variable like $name (with a leading $ character). (object) </td></tr>
+    #             </table>
+    #             <br />
+    #             **`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>
+    #             <br />
+    #             **`add_group_members`**, **`remove_group_members`**:
+    #             <table>
+    #             <tr><td> `group_id` </td> <td> The ID of the group
+    #             (string) </td></tr>
+    #             </table>
+    #             <br />
+    #             **`add_label`**, **`remove_label`**:
+    #             <table>
+    #             <tr><td> `label_id` </td> <td> The ID of the label
+    #             (string) </td></tr>
+    #             </table>
+    #             <br />
+    #             **`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>
+    #             <br />
+    #             **`set_send_blocked`**:
+    #             <table>
+    #             <tr><td> `send_blocked` </td> <td> `true` to block
+    #             sending messages, `false` to unblock sending messages (boolean) </td></tr>
+    #             </table>
+    #             <br />
+    #             **`set_conversation_status`**:
+    #             <table>
+    #             <tr><td> `conversation_status` </td> <td> "active",
+    #             "handled", or "closed" (string) </td></tr>
+    #             </table>
+    #             <br />
+    #             **`export_contacts`**, **`export_messages`**,
+    #             **`export_rows`**:
+    #             <table>
+    #             <tr><td>`storage_id` </td> <td> ID of a storage
+    #             provider where the CSV file will be saved. (string)
+    #             
+    #             Currently only AWS S3 is supported as a storage
+    #             provider.
+    #             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.
+    #             You can configure your own S3 bucket as a
+    #             storage provider on the <a href="/dashboard/a/storage">Storage Providers</a> page.
+    #             
+    #             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>
+    #             <br />
+    #             **`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.
     # 
@@ -1288,16 +1682,15 @@ class Project < Entity
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter scheduled messages by time_created
-    #         * Allowed modifiers: time_created[ne], time_created[min], time_created[max]
+    #         * Allowed modifiers: time_created[min], time_created[max]
     #     
     #     - 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[min], next_time[max], next_time[exists]
     #     
     #     - sort
     #         * Sort the results based on a field
-    #         * Allowed values: default, name
+    #         * Allowed values: default, next_time
     #         * Default: default
     #     
     #     - sort_dir
@@ -1369,7 +1762,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
@@ -1510,6 +1903,274 @@ 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
+
+    #
+    # Gets a list of all custom fields defined for contacts in this project. The return value is
+    # an array of objects with the properties 'name', 'variable', 'type', 'order', 'readonly', and
+    # 'lookup_key'. (Fields are automatically created any time a Contact's 'vars' property is
+    # updated.)
+    # 
+    # Returns:
+    #     array
+    #
+    def get_contact_fields()
+        return @api.do_request("GET", get_base_api_path() + "/contact_fields")
+    end
+
+    #
+    # Allows customizing how a custom contact field is displayed in the Telerivet web app.
+    # 
+    # Arguments:
+    #   - variable
+    #       * The variable name of the field to create or update.
+    #       * Required
+    #   
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - name (string, max 64 characters)
+    #         * Display name for the field
+    #     
+    #     - type (int)
+    #         * Field type
+    #         * Allowed values: text, long_text, phone_number, email, url, audio, date, date_time,
+    #             number, boolean, select
+    #     
+    #     - order (int)
+    #         * Order in which to display the field
+    #     
+    #     - 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`
+    #     
+    #     - readonly (bool)
+    #         * Set to true to prevent editing the field in the Telerivet web app
+    #     
+    #     - lookup_key (bool)
+    #         * Set to true to allow using this field as a lookup key when importing contacts via
+    #             the Telerivet web app
+    #     
+    #     - show_on_conversation (bool)
+    #         * Set to true to show field on Conversations tab
+    #   
+    # Returns:
+    #     object
+    #
+    def set_contact_field_metadata(variable, options)
+        return @api.do_request("POST", get_base_api_path() + "/contact_fields/#{variable}", options)
+    end
+
+    #
+    # Gets a list of all custom fields defined for messages in this project. The return value is
+    # an array of objects with the properties 'name', 'variable', 'type', 'order', 'readonly', and
+    # 'lookup_key'. (Fields are automatically created any time a Contact's 'vars' property is
+    # updated.)
+    # 
+    # Returns:
+    #     array
+    #
+    def get_message_fields()
+        return @api.do_request("GET", get_base_api_path() + "/message_fields")
+    end
+
+    #
+    # Allows customizing how a custom message field is displayed in the Telerivet web app.
+    # 
+    # Arguments:
+    #   - variable
+    #       * The variable name of the field to create or update.
+    #       * Required
+    #   
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - name (string, max 64 characters)
+    #         * Display name for the field
+    #     
+    #     - type (string)
+    #         * Field type
+    #         * Allowed values: text, long_text, phone_number, email, url, audio, date, date_time,
+    #             number, boolean, select
+    #     
+    #     - order (int)
+    #         * Order in which to display the field
+    #     
+    #     - 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`
+    #     
+    #     - hide_values (bool)
+    #         * Set to true to avoid showing values of this field on the Messages page
+    #   
+    # Returns:
+    #     object
+    #
+    def set_message_field_metadata(variable, options)
+        return @api.do_request("POST", get_base_api_path() + "/message_fields/#{variable}", options)
+    end
+
+    #
+    # Retrieves statistics about messages sent or received via Telerivet. This endpoint returns
+    # historical data that is computed shortly after midnight each day in the project's time zone,
+    # and does not contain message statistics for the current day.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - start_date (string)
+    #         * Start date of message statistics, in YYYY-MM-DD format
+    #         * Required
+    #     
+    #     - end_date (string)
+    #         * End date of message statistics (inclusive), in YYYY-MM-DD format
+    #         * Required
+    #     
+    #     - rollup (string)
+    #         * Date interval to group by
+    #         * Allowed values: day, week, month, year, all
+    #         * Default: day
+    #     
+    #     - properties (string)
+    #         * Comma separated list of properties to group by
+    #         * Allowed values: org_id, org_name, org_industry, project_id, project_name, user_id,
+    #             user_email, user_name, phone_id, phone_name, phone_type, direction, source, status,
+    #             network_code, network_name, message_type, service_id, service_name, simulated, link
+    #     
+    #     - metrics (string)
+    #         * Comma separated list of metrics to return (summed for each distinct value of the
+    #             requested properties)
+    #         * Allowed values: count, num_parts, duration, price
+    #         * Required
+    #     
+    #     - currency (string)
+    #         * Three-letter ISO 4217 currency code used when returning the 'price' field. If the
+    #             original price was in a different currency, it will be converted to the requested
+    #             currency using the approximate current exchange rate.
+    #         * Default: USD
+    #     
+    #     - filters (Hash)
+    #         * Key-value pairs of properties and corresponding values; the returned statistics
+    #             will only include messages where the property matches the provided value. Only the
+    #             following properties are supported for filters: `user_id`, `phone_id`, `direction`,
+    #             `source`, `status`, `service_id`, `simulated`, `message_type`, `network_code`
+    #   
+    # Returns:
+    #     (associative array)
+    #       - intervals (array)
+    #           * List of objects representing each date interval containing at least one message
+    #               matching the filters.
+    #               Each object has the following properties:
+    #               
+    #               <table>
+    #               <tr><td> start_time </td> <td> The UNIX timestamp of the start
+    #               of the interval (int) </td></tr>
+    #               <tr><td> end_time </td> <td> The UNIX timestamp of the end of
+    #               the interval, exclusive (int) </td></tr>
+    #               <tr><td> start_date </td> <td> The date of the start of the
+    #               interval in YYYY-MM-DD format (string) </td></tr>
+    #               <tr><td> end_date </td> <td> The date of the end of the
+    #               interval in YYYY-MM-DD format, inclusive (string) </td></tr>
+    #               <tr><td> groups </td> <td> Array of groups for each
+    #               combination of requested property values matching the filters (array)
+    #               <br /><br />
+    #               Each object has the following properties:
+    #               <table>
+    #               <tr><td> properties </td> <td> An object of key/value
+    #               pairs for each distinct value of the requested properties (object) </td></tr>
+    #               <tr><td> metrics </td> <td> An object of key/value pairs
+    #               for each requested metric (object) </td></tr>
+    #               </table>
+    #               </td></tr>
+    #               </table>
+    #
+    def get_message_stats(options)
+        data = @api.do_request("GET", get_base_api_path() + "/message_stats", options)
+        return data
+    end
+
     #
     # Saves any fields or custom variables that have changed for the project.
     #