telerivet 1.4.5 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0633af0317a3ef409a86481a483f934d2832d2f6a11fd545221997c3ebb495ad
-  data.tar.gz: 344a694d8cc84a5231cefa14d26f89fceecf6d140f201e013705794684f94015
+  metadata.gz: 303a6df0ce9d23233621cac3732ab09afb1b9bf968d784441e29bd343a4ec105
+  data.tar.gz: fad6a45b9e7b0cd84668f49a129a6600b3fcd4898b18d193d476deede36c9323
 SHA512:
-  metadata.gz: 74a877df3a572e3b1d96922343d0bc54ed58a2f2d28b36bf883691a3b440244e777cdb74cfed10f701a2f8a768dd157e5ada0f116b1c588774744080699fabc8
-  data.tar.gz: b75d13f319943c2f899200a1845932aad01205a902b280c2128d8bf19c7453b696386a539c278df2a1a19cba14c018189a817a622f2897d229b63eba3f94b7f3
+  metadata.gz: 4b030343b0e5d79d4c1d520d348baccfe77a7d171fab5b86f1f3a0b16e914f82ad3c5eab796fd2ddcec3480a1f952e030208f5db2eaaa568b3eb079fddbaa1ca
+  data.tar.gz: a8c12e9cfbb08f568f40cb4647646d033aa55d1864b1acd28219ff27d587d04ef2bff994b8aa0ab43c3082446de03bebe2ad90a99ba25a22ea40700505954e68

data/lib/telerivet/airtimetransaction.rb

@@ -0,0 +1,139 @@
+
+module Telerivet
+
+#
+# Represents a transaction where airtime is sent to a mobile phone number.
+# 
+# To send airtime, first [create a Custom Actions service to send a particular amount of
+# airtime](/dashboard/add_service?subtype_id=main.service.rules.contact&action_id=main.rule.sendairtime),
+# then trigger the service using [service.invoke](#Service.invoke),
+# [project.sendBroadcast](#Project.sendBroadcast), or
+# [project.scheduleMessage](#Project.scheduleMessage).
+# 
+# Fields:
+# 
+#   - id
+#       * ID of the airtime transaction
+#       * Read-only
+#   
+#   - to_number
+#       * Destination phone number in international format (no leading +)
+#       * Read-only
+#   
+#   - operator_name
+#       * Operator name
+#       * Read-only
+#   
+#   - country
+#       * Country code
+#       * Read-only
+#   
+#   - status
+#       * Current status of airtime transaction (`successful`, `failed`, `cancelled`,
+#           `queued`, `pending_approval`, or `pending_payment`)
+#       * Read-only
+#   
+#   - status_text
+#       * Error or success message returned by airtime provider, if available
+#       * Read-only
+#   
+#   - value
+#       * Value of airtime sent to destination phone number, in units of value_currency
+#       * Read-only
+#   
+#   - value_currency
+#       * Currency code of price
+#       * Read-only
+#   
+#   - price
+#       * Price charged for airtime transaction, in units of price_currency
+#       * Read-only
+#   
+#   - price_currency
+#       * Currency code of price
+#       * Read-only
+#   
+#   - contact_id
+#       * ID of the contact the airtime was sent to
+#       * Read-only
+#   
+#   - service_id
+#       * ID of the service that sent the airtime
+#       * Read-only
+#   
+#   - project_id
+#       * 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
+#
+class AirtimeTransaction < Entity
+    def id
+        get('id')
+    end
+
+    def to_number
+        get('to_number')
+    end
+
+    def operator_name
+        get('operator_name')
+    end
+
+    def country
+        get('country')
+    end
+
+    def status
+        get('status')
+    end
+
+    def status_text
+        get('status_text')
+    end
+
+    def value
+        get('value')
+    end
+
+    def value_currency
+        get('value_currency')
+    end
+
+    def price
+        get('price')
+    end
+
+    def price_currency
+        get('price_currency')
+    end
+
+    def contact_id
+        get('contact_id')
+    end
+
+    def service_id
+        get('service_id')
+    end
+
+    def project_id
+        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
+ 
+end
+
+end

data/lib/telerivet/broadcast.rb

@@ -109,7 +109,7 @@ module Telerivet
 #   
 #   - source
 #       * How the message originated within Telerivet
-#       * Allowed values: phone, provider, web, api, service, webhook, scheduled
+#       * Allowed values: phone, provider, web, api, service, webhook, scheduled, integration
 #       * Read-only
 #   
 #   - simulated (bool)
@@ -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

@@ -27,6 +27,11 @@ module Telerivet
 #       * True if Telerivet is blocked from sending messages to this contact
 #       * Updatable via API
 #   
+#   - conversation_status
+#       * Current status of the conversation with this contact
+#       * Allowed values: closed, active, handled
+#       * Updatable via API
+#   
 #   - last_message_time (UNIX timestamp)
 #       * Last time the contact sent or received a message (null if no messages have been sent
 #           or received)
@@ -133,7 +138,8 @@ class Contact < 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
@@ -141,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
@@ -151,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
@@ -243,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[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
@@ -284,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
@@ -325,9 +338,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
@@ -405,6 +418,14 @@ class Contact < Entity
         set('send_blocked', value)
     end
 
+    def conversation_status
+        get('conversation_status')
+    end
+
+    def conversation_status=(value)
+        set('conversation_status', value)
+    end
+
     def last_message_time
         get('last_message_time')
     end

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)
@@ -54,16 +55,16 @@ 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
     #     
     #     - 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
@@ -168,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
+    #         * 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

@@ -50,28 +50,26 @@ 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
-    #         * 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
@@ -88,9 +86,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
@@ -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[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

data/lib/telerivet/label.rb

@@ -43,7 +43,8 @@ class Label < 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
@@ -51,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
@@ -61,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
@@ -28,7 +28,7 @@ module Telerivet
 #   
 #   - source
 #       * How the message originated within Telerivet
-#       * Allowed values: phone, provider, web, api, service, webhook, scheduled
+#       * Allowed values: phone, provider, web, api, service, webhook, scheduled, integration
 #       * Read-only
 #   
 #   - time_created (UNIX timestamp)
@@ -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