telerivet 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e063e2ce507f6d45b86d12c584475887c050c3d439863d91d545b0ba331e823
-  data.tar.gz: d8040eb663854c7df190aa8f49984d9854687238532b6278af53dea6ebc77250
+  metadata.gz: 303a6df0ce9d23233621cac3732ab09afb1b9bf968d784441e29bd343a4ec105
+  data.tar.gz: fad6a45b9e7b0cd84668f49a129a6600b3fcd4898b18d193d476deede36c9323
 SHA512:
-  metadata.gz: da5e09e1c639a5e1bd3b704214c4a276d62469e6ae0853d71cbe4b9dc2a2aacbb1f58d5e5bcbf1093e5cbf24a7a99abcf30d029883aca055d4b41ae9f3a7f8ff
-  data.tar.gz: 4ad80ced036f9d8810e3e7f693443247740791ed4097b26ce179c2c2ef0ca06986b41942fde40401ea8989df19591f84834439efb74900f9bb57ec7f939d8f25
+  metadata.gz: 4b030343b0e5d79d4c1d520d348baccfe77a7d171fab5b86f1f3a0b16e914f82ad3c5eab796fd2ddcec3480a1f952e030208f5db2eaaa568b3eb079fddbaa1ca
+  data.tar.gz: a8c12e9cfbb08f568f40cb4647646d033aa55d1864b1acd28219ff27d587d04ef2bff994b8aa0ab43c3082446de03bebe2ad90a99ba25a22ea40700505954e68

data/lib/telerivet/broadcast.rb

@@ -144,6 +144,13 @@ module Telerivet
 #       * Custom variables stored for this broadcast
 #       * Read-only
 #   
+#   - 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.
+#       * Read-only
+#   
 #   - price (number)
 #       * The total price of all messages in this broadcast, if known.
 #       * Read-only
@@ -282,6 +289,10 @@ class Broadcast < Entity
         get('media')
     end
 
+    def route_params
+        get('route_params')
+    end
+
     def price
         get('price')
     end

data/lib/telerivet/contact.rb

@@ -147,7 +147,7 @@ class Contact < 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
@@ -157,18 +157,26 @@ class Contact < 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
@@ -249,16 +257,15 @@ class Contact < 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[ne], next_time[min], next_time[max],
-    #             next_time[exists]
+    #         * 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
@@ -290,7 +297,7 @@ class Contact < Entity
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter data rows by the time they were created
-    #         * Allowed modifiers: time_created[ne], time_created[min], time_created[max]
+    #         * Allowed modifiers: time_created[min], time_created[max]
     #     
     #     - sort
     #         * Sort the results based on a field

data/lib/telerivet/datatable.rb

@@ -55,7 +55,7 @@ class DataTable < Entity
     #     
     #     - time_created (UNIX timestamp)
     #         * Filter data rows by the time they were created
-    #         * Allowed modifiers: time_created[ne], time_created[min], time_created[max]
+    #         * Allowed modifiers: time_created[min], time_created[max]
     #     
     #     - contact_id
     #         * Filter data rows associated with a particular contact
@@ -169,25 +169,36 @@ class DataTable < Entity
     #       * Required
     #   
     #   - options (Hash)
+    #       * Required
     #     
     #     - name (string, max 64 characters)
     #         * Display name for the field
     #     
     #     - type (string)
     #         * Field type
-    #         * Allowed values: text, long_text, number, boolean, email, url, audio, phone_number,
-    #             date, date_time, groups, route, select, buttons, contact
+    #         * 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 rows via the
+    #             Telerivet web app
     #   
     # Returns:
     #     object
     #
-    def set_field_metadata(variable, options = nil)
+    def set_field_metadata(variable, options)
         return @api.do_request("POST", get_base_api_path() + "/fields/#{variable}", options)
     end
 

data/lib/telerivet/group.rb

@@ -54,24 +54,22 @@ class Group < Entity
     #     
     #     - 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[ne], last_message_time[min],
-    #             last_message_time[max], last_message_time[exists]
+    #         * 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[ne],
-    #             last_incoming_message_time[min], last_incoming_message_time[max],
-    #             last_incoming_message_time[exists]
+    #         * 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[ne],
-    #             last_outgoing_message_time[min], last_outgoing_message_time[max],
-    #             last_outgoing_message_time[exists]
+    #         * 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
@@ -130,16 +128,15 @@ class Group < 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[ne], next_time[min], next_time[max],
-    #             next_time[exists]
+    #         * 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

data/lib/telerivet/label.rb

@@ -52,7 +52,7 @@ class Label < 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
@@ -62,18 +62,26 @@ class Label < 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

data/lib/telerivet/message.rb

@@ -18,7 +18,7 @@ module Telerivet
 #   - status
 #       * Current status of the message
 #       * Allowed values: ignored, processing, received, sent, queued, failed, failed_queued,
-#           cancelled, delivered, not_delivered
+#           cancelled, delivered, not_delivered, read
 #       * Read-only
 #   
 #   - message_type
@@ -71,6 +71,13 @@ module Telerivet
 #       * List of IDs of labels applied to this message
 #       * Read-only
 #   
+#   - route_params (Hash)
+#       * Route-specific parameters for 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 the message is sent by that type of route.
+#       * Read-only
+#   
 #   - vars (Hash)
 #       * Custom variables stored for this message
 #       * Updatable via API
@@ -122,15 +129,6 @@ module Telerivet
 #       * Allowed values: female, male
 #       * Read-only
 #   
-#   - mms_parts (array)
-#       * A list of parts in the MMS message, the same as returned by the
-#           [getMMSParts](#Message.getMMSParts) method.
-#           
-#           Note: This property is only present when retrieving an individual
-#           MMS message by ID, not when querying a list of messages. In other cases, use
-#           [getMMSParts](#Message.getMMSParts).
-#       * Read-only
-#   
 #   - track_clicks (boolean)
 #       * If true, URLs in the message content are short URLs that redirect to a destination
 #           URL.
@@ -138,12 +136,12 @@ module Telerivet
 #   
 #   - short_urls (array)
 #       * For text messages containing short URLs, this is an array of objects with the
-#           properties `short_url`, `link_type`, and `time_clicked` (the first time that URL was
-#           clicked). If `link_type` is "redirect", the object also contains a `destination_url`
-#           property. If `link_type` is "media", the object also contains an `media_index`
-#           property (the index in the media array). If `link_type` is "service", the object also
-#           contains a `service_id` property. This property is undefined for messages that do not
-#           contain short URLs.
+#           properties `short_url`, `link_type`, `time_clicked` (the first time that URL was
+#           clicked), and `expiration_time`. If `link_type` is "redirect", the object also
+#           contains a `destination_url` property. If `link_type` is "media", the object also
+#           contains an `media_index` property (the index in the media array). If `link_type` is
+#           "service", the object also contains a `service_id` property. This property is
+#           undefined for messages that do not contain short URLs.
 #       * Read-only
 #   
 #   - media (array)
@@ -154,6 +152,27 @@ module Telerivet
 #           temporary and may not be valid for more than 1 day.
 #       * Read-only
 #   
+#   - mms_parts (array)
+#       * A list of parts in the MMS message (only for incoming MMS messages received via
+#           Telerivet Gateway Android app).
+#           
+#           Each MMS part in the list is an object with the following
+#           properties:
+#           
+#           - cid: MMS content-id
+#           - type: MIME type
+#           - filename: original filename
+#           - size (int): number of bytes
+#           - url: URL where the content for this part is stored (secret but
+#           publicly accessible, so you could link/embed it in a web page without having to
+#           re-host it yourself)
+#           
+#           In general, the `media` property of the message is recommended for
+#           retrieving information about MMS media files, instead of `mms_parts`.
+#           The `mms_parts` property is also only present when retrieving an
+#           individual MMS message by ID, not when querying a list of messages.
+#       * Read-only
+#   
 #   - time_clicked (UNIX timestamp)
 #       * If the message contains any short URLs, this is the first time that a short URL in
 #           the message was clicked.  This property is undefined for messages that do not contain
@@ -237,18 +256,15 @@ class Message < Entity
     end
 
     #
-    # Retrieves a list of MMS parts for this message (empty for non-MMS messages).
+    # (Deprecated) Retrieves a list of MMS parts for this message (only for incoming MMS messages
+    # received via Telerivet Gateway Android app).
+    # Note: This only works for MMS messages received via the Telerivet
+    # Gateway Android app.
+    # In general, the `media` property of the message is recommended for
+    # retrieving information about MMS media files.
     # 
-    # Each MMS part in the list is an object with the following
-    # properties:
-    # 
-    # - cid: MMS content-id
-    # - type: MIME type
-    # - filename: original filename
-    # - size (int): number of bytes
-    # - url: URL where the content for this part is stored (secret but
-    # publicly accessible, so you could link/embed it in a web page without having to re-host it
-    # yourself)
+    # The return value has the same format as the `mms_parts` property of
+    # the Message object.
     # 
     # Returns:
     #     array
@@ -364,6 +380,10 @@ class Message < Entity
         get('label_ids')
     end
 
+    def route_params
+        get('route_params')
+    end
+
     def priority
         get('priority')
     end
@@ -408,10 +428,6 @@ class Message < Entity
         get('tts_voice')
     end
 
-    def mms_parts
-        get('mms_parts')
-    end
-
     def track_clicks
         get('track_clicks')
     end
@@ -424,6 +440,10 @@ class Message < Entity
         get('media')
     end
 
+    def mms_parts
+        get('mms_parts')
+    end
+
     def time_clicked
         get('time_clicked')
     end

data/lib/telerivet/organization.rb

@@ -98,6 +98,86 @@ class Organization < Entity
         return @api.do_request("GET", get_base_api_path() + "/usage/#{usage_type}")
     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
+
     #
     # Queries projects in this organization.
     # 

data/lib/telerivet/phone.rb

@@ -124,7 +124,7 @@ class Phone < 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
@@ -134,18 +134,26 @@ class Phone < 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

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
@@ -664,24 +753,22 @@ class Project < Entity
     #     
     #     - 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[ne], last_message_time[min],
-    #             last_message_time[max], last_message_time[exists]
+    #         * 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[ne],
-    #             last_incoming_message_time[min], last_incoming_message_time[max],
-    #             last_incoming_message_time[exists]
+    #         * 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[ne],
-    #             last_outgoing_message_time[min], last_outgoing_message_time[max],
-    #             last_outgoing_message_time[exists]
+    #         * 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
@@ -779,8 +866,8 @@ class Project < Entity
     #     
     #     - last_active_time (UNIX timestamp)
     #         * Filter phones by last active time
-    #         * Allowed modifiers: last_active_time[ne], last_active_time[min],
-    #             last_active_time[max], last_active_time[exists]
+    #         * Allowed modifiers: last_active_time[min], last_active_time[max],
+    #             last_active_time[exists]
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -868,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
@@ -878,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
@@ -1100,8 +1195,16 @@ class Project < Entity
     #             <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>
@@ -1110,50 +1213,50 @@ class Project < Entity
     #             <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
-    #             backend where the CSV file will be saved. (string)
+    #             provider where the CSV file will be saved. (string)
     #             
     #             Currently only AWS S3 is supported as a storage
-    #             backend.
+    #             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.
-    #             To configure your own S3 bucket as a storage
-    #             backend, contact support.
+    #             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.
@@ -1164,7 +1267,7 @@ class Project < Entity
     #             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.
@@ -1579,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[ne], next_time[min], next_time[max],
-    #             next_time[exists]
+    #         * 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
@@ -1880,6 +1982,195 @@ class Project < Entity
         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.
     #

data/lib/telerivet/scheduledmessage.rb

@@ -135,6 +135,13 @@ module Telerivet
 #           temporary and may not be valid for more than 1 day.
 #       * Read-only
 #   
+#   - 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.
+#       * Read-only
+#   
 #   - vars (Hash)
 #       * Custom variables stored for this scheduled message (copied to Message when sent)
 #       * Updatable via API
@@ -258,6 +265,10 @@ class ScheduledMessage < Entity
         get('media')
     end
 
+    def route_params
+        get('route_params')
+    end
+
     def label_ids
         get('label_ids')
     end

data/lib/telerivet/service.rb

@@ -117,6 +117,15 @@ class Service < Entity
     #             or `phone_number` is required if `context` is 'contact'). If no  contact exists with
     #             this phone number, a new contact will be created.
     #     
+    #     - variables (Hash)
+    #         * 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).
+    #     
     #     - route_id
     #         * The ID of the phone or route that the service will use for sending messages by
     #             default

data/lib/telerivet.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerivet
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Jesse Young
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-27 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com