telerivet 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2276ff47e23f0670121a7295c0cf3d860740ebb0c1980de13e15ae2f25c2659d
-  data.tar.gz: 55db2507c8bcfa9f8ed0c3102f830dea689fd57ef57d0a00f1b488eebf46f4b5
+  metadata.gz: 53eb2eb3eda20f383f980d2b94f38955f16ae139b588b14ad547dbbd371642f9
+  data.tar.gz: d65a986a9fa2e2ed62bb0245595ad7d3d76bc607774f13314efd64b4d2405762
 SHA512:
-  metadata.gz: cdd68937b393e61a1ec76e536b0abfcf30e3bb16127b2ea6a37f221013c8ee9d43aa99f5bf758eeb70d04c0366ffcfe1a2e4af576d0620507412b92ac8ceeab7
-  data.tar.gz: 50cf5362c2926a104d8e1d6cd15ee5473589cdf31e78e516f9e6ad1af335baec040de5b5cf8598dc8e95008e08fe9775a448da465fffc708030b8e217d86e52a
+  metadata.gz: 748e80a811e0791268fb144fec9eca46e8c0beaea561d616a21c01b461d3baf4ca1063ead62ed9c6b9ce9070036f3db46b133878bc2d021dad8b7d010cf24d89
+  data.tar.gz: 85630bd869da8d7a42c0ef137d2e95c583b47796e4efbe581c86ebf15542022a08f2d27d42a97b5efc7007008525ad5ba5756a4f714b86ab4b6ef734deac200d

data/lib/telerivet/airtimetransaction.rb

@@ -38,7 +38,7 @@ module Telerivet
 #   
 #   - status
 #       * Current status of airtime transaction (`successful`, `failed`, `cancelled`,
-#           `queued`, `pending_approval`, or `pending_payment`)
+#           `queued`, `processing`, `submitted`, `pending_approval`, or `pending_payment`)
 #       * Read-only
 #   
 #   - status_text
@@ -77,8 +77,17 @@ module Telerivet
 #       * The ID of this transaction from an external airtime gateway provider, if available.
 #       * Read-only
 #   
+#   - user_id (string, max 34 characters)
+#       * ID of the Telerivet user who sent the airtime transaction (if applicable)
+#       * Read-only
+#   
 #   - vars (Hash)
-#       * Custom variables stored for this transaction
+#       * Custom variables stored for this transaction. Variable names may be up to 32
+#           characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #
 class AirtimeTransaction < Entity
@@ -146,6 +155,10 @@ class AirtimeTransaction < Entity
         get('external_id')
     end
 
+    def user_id
+        get('user_id')
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/airtime_transactions/#{get('id')}"
     end

data/lib/telerivet/broadcast.rb

@@ -141,14 +141,22 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this broadcast
+#       * Custom variables stored for this broadcast. Variable names may be up to 32
+#           characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * 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.
+#       * Route-specific parameters for the messages in the broadcast.
+#           
+#           When sending messages via chat apps such as WhatsApp, the route_params
+#           parameter can be used to send messages with app-specific features such as quick
+#           replies and link buttons.
+#           
+#           For more details, see [Route-Specific Parameters](#route_params).
 #       * Read-only
 #   
 #   - price (number)

data/lib/telerivet/contact.rb

@@ -72,7 +72,12 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this contact
+#       * Custom variables stored for this contact. Variable names may be up to 32 characters
+#           in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id

data/lib/telerivet/contactservicestate.rb

@@ -40,7 +40,12 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this contact/service state
+#       * Custom variables stored for this contact/service state. Variable names may be up to
+#           32 characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - time_created (UNIX timestamp)

data/lib/telerivet/datarow.rb

@@ -28,7 +28,12 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this data row
+#       * Custom variables stored for this data row. Variable names may be up to 32 characters
+#           in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - time_created (UNIX timestamp)

data/lib/telerivet/datatable.rb

@@ -31,7 +31,8 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - show_stats (bool)
-#       * Whether to show row statistics in the web app
+#       * Whether to show summary charts (pie charts, bar charts, tables of top values) for
+#           this data table in the web app
 #       * Updatable via API
 #   
 #   - show_contact_columns (bool)
@@ -39,7 +40,12 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this data table
+#       * Custom variables stored for this data table. Variable names may be up to 32
+#           characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id
@@ -105,7 +111,12 @@ class DataTable < Entity
     #         * Phone number that this row is associated with (if applicable)
     #     
     #     - vars
-    #         * Custom variables and values to set for this data row
+    #         * Custom variables and values to set for this data row. Variable names may be up to
+    #             32 characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+    #             Values may be strings, numbers, or boolean (true/false).
+    #             String values may be up to 4096 bytes in length when encoded as UTF-8.
+    #             Up to 100 variables are supported per object.
+    #             Setting a variable to null will delete the variable.
     #   
     # Returns:
     #     Telerivet::DataRow
@@ -163,6 +174,9 @@ class DataTable < Entity
     #
     # Allows customizing how a field (column) is displayed in the Telerivet web app.
     # 
+    # The variable path parameter can contain the characters a-z, A-Z,
+    # 0-9, and _, and may be up to 32 characters in length.
+    # 
     # Arguments:
     #   - variable
     #       * The variable name of the field to create or update.
@@ -177,7 +191,7 @@ class DataTable < Entity
     #     - type (string)
     #         * Field type
     #         * Allowed values: text, long_text, secret, phone_number, email, url, audio, date,
-    #             date_time, number, boolean, checkbox, select, radio
+    #             date_time, number, boolean, checkbox, select, radio, route
     #     
     #     - order (int)
     #         * Order in which to display the field

data/lib/telerivet/group.rb

@@ -26,8 +26,23 @@ module Telerivet
 #       * Time the group was created in Telerivet
 #       * Read-only
 #   
+#   - allow_sending (bool)
+#       * True if messages can be sent to this group, false otherwise.
+#       * Updatable via API
+#   
+#   - add_time_variable (string)
+#       * Variable name of a custom contact field that will automatically be set to the
+#           current date/time on any contact that is added to the group. This variable will only
+#           be set if the contact does not already have a value for this variable.
+#       * Updatable via API
+#   
 #   - vars (Hash)
-#       * Custom variables stored for this group
+#       * Custom variables stored for this group. Variable names may be up to 32 characters in
+#           length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id
@@ -201,6 +216,22 @@ class Group < Entity
         get('time_created')
     end
 
+    def allow_sending
+        get('allow_sending')
+    end
+
+    def allow_sending=(value)
+        set('allow_sending', value)
+    end
+
+    def add_time_variable
+        get('add_time_variable')
+    end
+
+    def add_time_variable=(value)
+        set('add_time_variable', value)
+    end
+
     def project_id
         get('project_id')
     end

data/lib/telerivet/label.rb

@@ -19,7 +19,12 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this label
+#       * Custom variables stored for this label. Variable names may be up to 32 characters in
+#           length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id

data/lib/telerivet/message.rb

@@ -72,14 +72,22 @@ module Telerivet
 #       * 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.
+#       * Route-specific parameters for the message.
+#           
+#           When sending messages via chat apps such as WhatsApp, the route_params
+#           parameter can be used to send messages with app-specific features such as quick
+#           replies and link buttons.
+#           
+#           For more details, see [Route-Specific Parameters](#route_params).
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this message
+#       * Custom variables stored for this message. Variable names may be up to 32 characters
+#           in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - priority (int)
@@ -92,6 +100,13 @@ module Telerivet
 #           omitted from the API response if there is no error message.)
 #       * Updatable via API
 #   
+#   - error_code
+#       * A route-specific error code encountered while sending a message. The error code
+#           values depend on the provider and may be described in the provider's API
+#           documentation. Error codes may be strings or numbers, depending on the provider. (This
+#           field is omitted from the API response if there is no error code.)
+#       * Read-only
+#   
 #   - external_id
 #       * The ID of this message from an external SMS gateway provider (e.g. Twilio or
 #           Vonage), if available.
@@ -410,6 +425,10 @@ class Message < Entity
         set('error_message', value)
     end
 
+    def error_code
+        get('error_code')
+    end
+
     def external_id
         get('external_id')
     end

data/lib/telerivet/phone.rb

@@ -45,7 +45,12 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this phone
+#       * Custom variables stored for this phone. Variable names may be up to 32 characters in
+#           length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id

data/lib/telerivet/project.rb

@@ -42,7 +42,12 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this project
+#       * Custom variables stored for this project. Variable names may be up to 32 characters
+#           in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - organization_id (string, max 34 characters)
@@ -112,14 +117,25 @@ class Project < Entity
     #     
     #     - 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).
+    #             short links to each URL will be appended to the end of the content (separated by a
+    #             new line).
+    #             
+    #             
+    #             By default, each file must have a https:// or http:// URL, which requires the file
+    #             to be uploaded somewhere that is accessible via the internet. For media files that
+    #             are not already accessible via the internet, the media_urls parameter also supports
+    #             data URIs with the file data encoded via Base64 (e.g. "data:image/png;base64,..."),
+    #             with a maximum file size of 2 MB. To send media via data URIs, contact Telerivet to
+    #             request enabling the data URIs feature for your project.
     #     
     #     - 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.
+    #         * Route-specific parameters for the message.
+    #             
+    #             When sending messages via chat apps such as WhatsApp, the route_params
+    #             parameter can be used to send messages with app-specific features such as quick
+    #             replies and link buttons.
+    #             
+    #             For more details, see [Route-Specific Parameters](#route_params).
     #     
     #     - label_ids (array)
     #         * List of IDs of labels to add to this message
@@ -254,15 +270,26 @@ class Project < Entity
     #         * 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
     #             new line).
+    #             
+    #             
+    #             By default, each file must have a https:// or http:// URL, which requires the file
+    #             to be uploaded somewhere that is accessible via the internet. For media files that
+    #             are not already accessible via the internet, the media_urls parameter also supports
+    #             data URIs with the file data encoded via Base64 (e.g. "data:image/png;base64,..."),
+    #             with a maximum file size of 2 MB. To send media via data URIs, contact Telerivet to
+    #             request enabling the data URIs feature for your project.
     #     
     #     - 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.
+    #         * Route-specific parameters for the messages in the broadcast.
+    #             
+    #             When sending messages via chat apps such as WhatsApp, the route_params
+    #             parameter can be used to send messages with app-specific features such as quick
+    #             replies and link buttons.
+    #             
+    #             For more details, see [Route-Specific Parameters](#route_params).
     #     
     #     - service_id
     #         * Service to invoke for each recipient (when `message_type` is `call` or `service`)
@@ -370,14 +397,25 @@ class Project < Entity
     #     
     #     - 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).
+    #             short links to each URL will be appended to the end of the content (separated by a
+    #             new line).
+    #             
+    #             
+    #             By default, each file must have a https:// or http:// URL, which requires the file
+    #             to be uploaded somewhere that is accessible via the internet. For media files that
+    #             are not already accessible via the internet, the media_urls parameter also supports
+    #             data URIs with the file data encoded via Base64 (e.g. "data:image/png;base64,..."),
+    #             with a maximum file size of 2 MB. To send media via data URIs, contact Telerivet to
+    #             request enabling the data URIs feature for your project.
     #     
     #     - 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.
+    #         * Route-specific parameters to apply to all messages.
+    #             
+    #             When sending messages via chat apps such as WhatsApp, the route_params
+    #             parameter can be used to send messages with app-specific features such as quick
+    #             replies and link buttons.
+    #             
+    #             For more details, see [Route-Specific Parameters](#route_params).
     #     
     #     - vars (Hash)
     #         * Custom variables to store with the message
@@ -555,14 +593,25 @@ class Project < Entity
     #     
     #     - 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).
+    #             short links to each URL will be appended to the end of the content (separated by a
+    #             new line).
+    #             
+    #             
+    #             By default, each file must have a https:// or http:// URL, which requires the file
+    #             to be uploaded somewhere that is accessible via the internet. For media files that
+    #             are not already accessible via the internet, the media_urls parameter also supports
+    #             data URIs with the file data encoded via Base64 (e.g. "data:image/png;base64,..."),
+    #             with a maximum file size of 2 MB. To send media via data URIs, contact Telerivet to
+    #             request enabling the data URIs feature for your project.
     #     
     #     - 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.
+    #         * Route-specific parameters to use when sending the message.
+    #             
+    #             When sending messages via chat apps such as WhatsApp, the route_params
+    #             parameter can be used to send messages with app-specific features such as quick
+    #             replies and link buttons.
+    #             
+    #             For more details, see [Route-Specific Parameters](#route_params).
     #     
     #     - label_ids (array)
     #         * Array of IDs of labels to add to the sent messages (maximum 5). Does not apply
@@ -720,14 +769,25 @@ class Project < Entity
     #     
     #     - 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).
+    #             short links to each URL will be appended to the end of the content (separated by a
+    #             new line).
+    #             
+    #             
+    #             By default, each file must have a https:// or http:// URL, which requires the file
+    #             to be uploaded somewhere that is accessible via the internet. For media files that
+    #             are not already accessible via the internet, the media_urls parameter also supports
+    #             data URIs with the file data encoded via Base64 (e.g. "data:image/png;base64,..."),
+    #             with a maximum file size of 2 MB. To send media via data URIs, contact Telerivet to
+    #             request enabling the data URIs feature for your project.
     #     
     #     - 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.
+    #         * Route-specific parameters to use when sending the message.
+    #             
+    #             When sending messages via chat apps such as WhatsApp, the route_params
+    #             parameter can be used to send messages with app-specific features such as quick
+    #             replies and link buttons.
+    #             
+    #             For more details, see [Route-Specific Parameters](#route_params).
     #     
     #     - label_ids (array)
     #         * Array of IDs of labels to add to the sent messages (maximum 5). Does not apply
@@ -767,7 +827,7 @@ class Project < Entity
     #     
     #     - message_type
     #         * Type of message
-    #         * Allowed values: sms, call
+    #         * Allowed values: sms, call, chat
     #         * Default: sms
     #     
     #     - from_number
@@ -849,7 +909,12 @@ class Project < Entity
     #         * ID of one or more groups to remove this contact as a member (max 20)
     #     
     #     - vars (Hash)
-    #         * Custom variables and values to update on the contact
+    #         * Custom variables and values to update on the contact. Variable names may be up to
+    #             32 characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+    #             Values may be strings, numbers, or boolean (true/false).
+    #             String values may be up to 4096 bytes in length when encoded as UTF-8.
+    #             Up to 100 variables are supported per object.
+    #             Setting a variable to null will delete the variable.
     #   
     # Returns:
     #     Telerivet::Contact
@@ -2077,7 +2142,12 @@ class Project < Entity
     #         * Required
     #     
     #     - vars
-    #         * Custom variables and values to set for this service
+    #         * Custom variables and values to set for this service. Variable names may be up to
+    #             32 characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+    #             Values may be strings, numbers, or boolean (true/false).
+    #             String values may be up to 4096 bytes in length when encoded as UTF-8.
+    #             Up to 100 variables are supported per object.
+    #             Setting a variable to null will delete the variable.
     #     
     #     - active (bool)
     #         * Whether the service is initially active or inactive. Inactive services are not
@@ -2429,8 +2499,8 @@ class Project < Entity
     #     
     #     - status
     #         * Filter transactions by status
-    #         * Allowed values: pending, queued, processing, successful, failed, cancelled,
-    #             pending_payment, pending_approval
+    #         * Allowed values: pending, queued, processing, submitted, successful, failed,
+    #             cancelled, pending_payment, pending_approval
     #     
     #     - sort_dir
     #         * Sort the results in ascending or descending order
@@ -2501,6 +2571,9 @@ class Project < Entity
     #
     # Allows customizing how a custom contact field is displayed in the Telerivet web app.
     # 
+    # The variable path parameter can contain the characters a-z, A-Z,
+    # 0-9, and _, and may be up to 32 characters in length.
+    # 
     # Arguments:
     #   - variable
     #       * The variable name of the field to create or update.
@@ -2515,7 +2588,7 @@ class Project < Entity
     #     - type (int)
     #         * Field type
     #         * Allowed values: text, long_text, secret, phone_number, email, url, audio, date,
-    #             date_time, number, boolean, checkbox, select, radio
+    #             date_time, number, boolean, checkbox, select, radio, route
     #     
     #     - order (int)
     #         * Order in which to display the field
@@ -2559,6 +2632,9 @@ class Project < Entity
     #
     # Allows customizing how a custom message field is displayed in the Telerivet web app.
     # 
+    # The variable path parameter can contain the characters a-z, A-Z,
+    # 0-9, and _, and may be up to 32 characters in length.
+    # 
     # Arguments:
     #   - variable
     #       * The variable name of the field to create or update.
@@ -2573,7 +2649,7 @@ class Project < Entity
     #     - type (string)
     #         * Field type
     #         * Allowed values: text, long_text, secret, phone_number, email, url, audio, date,
-    #             date_time, number, boolean, checkbox, select, radio
+    #             date_time, number, boolean, checkbox, select, radio, route
     #     
     #     - order (int)
     #         * Order in which to display the field

data/lib/telerivet/relativescheduledmessage.rb

@@ -134,15 +134,23 @@ module Telerivet
 #       * 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.
+#       * Route-specific parameters to use when sending the message.
+#           
+#           When sending messages via chat apps such as WhatsApp, the route_params
+#           parameter can be used to send messages with app-specific features such as quick
+#           replies and link buttons.
+#           
+#           For more details, see [Route-Specific Parameters](#route_params).
 #       * Updatable via API
 #   
 #   - vars (Hash)
 #       * Custom variables stored for this scheduled message (copied to each ScheduledMessage
-#           and Message when sent)
+#           and Message when sent). Variable names may be up to 32 characters in length and can
+#           contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - label_ids (array)

data/lib/telerivet/route.rb

@@ -23,7 +23,12 @@ module Telerivet
 #       * Updatable via API
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this route
+#       * Custom variables stored for this route. Variable names may be up to 32 characters in
+#           length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id

data/lib/telerivet/scheduledmessage.rb

@@ -138,14 +138,23 @@ module Telerivet
 #       * 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.
+#       * Route-specific parameters to use when sending the message.
+#           
+#           When sending messages via chat apps such as WhatsApp, the route_params
+#           parameter can be used to send messages with app-specific features such as quick
+#           replies and link buttons.
+#           
+#           For more details, see [Route-Specific Parameters](#route_params).
 #       * Updatable via API
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this scheduled message (copied to Message when sent)
+#       * Custom variables stored for this scheduled message (copied to Message when sent).
+#           Variable names may be up to 32 characters in length and can contain the characters
+#           a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - label_ids (array)

data/lib/telerivet/service.rb

@@ -45,7 +45,12 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this service
+#       * Custom variables stored for this service. Variable names may be up to 32 characters
+#           in length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Updatable via API
 #   
 #   - project_id
@@ -230,7 +235,12 @@ class Service < Entity
     #         * Required
     #     
     #     - vars (Hash)
-    #         * Custom variables stored for this contact's state
+    #         * Custom variables stored for this contact's state. Variable names may be up to 32
+    #             characters in length and can contain the characters a-z, A-Z, 0-9, and _.
+    #             Values may be strings, numbers, or boolean (true/false).
+    #             String values may be up to 4096 bytes in length when encoded as UTF-8.
+    #             Up to 100 variables are supported per object.
+    #             Setting a variable to null will delete the variable.
     #   
     # Returns:
     #     Telerivet::ContactServiceState

data/lib/telerivet/task.rb

@@ -59,7 +59,12 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * Custom variables stored for this task
+#       * Custom variables stored for this task. Variable names may be up to 32 characters in
+#           length and can contain the characters a-z, A-Z, 0-9, and _.
+#           Values may be strings, numbers, or boolean (true/false).
+#           String values may be up to 4096 bytes in length when encoded as UTF-8.
+#           Up to 100 variables are supported per object.
+#           Setting a variable to null will delete the variable.
 #       * Read-only
 #   
 #   - table_id (string, max 34 characters)

data/lib/telerivet.rb

@@ -9,7 +9,7 @@ module Telerivet
 class API
     attr_reader :num_requests
 
-    @@client_version = '1.7.0'
+    @@client_version = '1.8.0'
 
     #
     # Initializes a client handle to the Telerivet REST API.
@@ -88,11 +88,11 @@ class API
             error_code = error['code']
 
             if error_code == 'invalid_param'
-                raise InvalidParameterException, error['message'] #, error['code'], error['param'])
+                raise InvalidParameterException.new error['message'], error['code'], error['param']
             elsif error_code == 'not_found'
-                raise NotFoundException, error['message'] #, error['code']);
+                raise NotFoundException.new error['message'], error['code']
             else
-                raise APIException, error['message'] #, error['code'])
+                raise APIException.new error['message'], error['code']
             end
         else
             return res
@@ -282,12 +282,24 @@ class API
 end
 
 class APIException < Exception
+    attr_reader :code
+
+    def initialize(msg, code)
+        @code = code
+        super(msg)
+    end
 end
 
 class NotFoundException < APIException
 end
 
 class InvalidParameterException < APIException
+    attr_reader :param
+
+    def initialize(msg, code, param)
+        @param = param
+        super(msg, code)
+    end
 end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telerivet
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Jesse Young
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2025-07-16 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client library for Telerivet REST API
 email: support@telerivet.com
@@ -41,7 +41,7 @@ homepage: http://telerivet.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,8 +56,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: Telerivet REST API Client
 test_files: []