telerivet 1.8.2 → 1.9.6

data/lib/telerivet/phone.rb

@@ -57,6 +57,63 @@ module Telerivet
 #       * ID of the project this phone belongs to
 #       * Read-only
 #   
+#   - validate_recipient_numbers (bool)
+#       * Set to true to check that recipient phone numbers appear to be valid before sending
+#           messages. Messages to invalid phone numbers will fail without being sent. Only applies
+#           to phones capable of sending messages.
+#       * Updatable via API
+#   
+#   - allowed_recipient_countries (array of strings)
+#       * Array of 2-letter country codes (ISO 3166-1 alpha-2) to which this phone is allowed
+#           to send messages. When null, there is no restriction on recipient countries.
+#       * Updatable via API
+#   
+#   - sent_message_limit (int)
+#       * Maximum number of messages that can be sent from this phone in a given period. When
+#           the sent_message_count reaches this limit, sending is automatically paused. Set to
+#           null to disable the limit.
+#       * Updatable via API
+#   
+#   - sent_message_count (int)
+#       * Number of messages sent from this phone since the counter was last reset (see
+#           sent_message_epoch). This property is not updated if sent_message_limit is null.
+#       * Read-only
+#   
+#   - sent_message_epoch (UNIX timestamp)
+#       * The UNIX timestamp when the sent_message_count was last reset to 0.
+#       * Read-only
+#   
+#   - send_delay (number)
+#       * Number of seconds to wait after sending each message from this phone, to avoid
+#           exceeding carrier rate limits.
+#       * Updatable via API
+#   
+#   - timezone_id (string)
+#       * A string specifying the time zone that will be used when implementing quiet hours or
+#           estimating send times; see [List of tz database time zones Wikipedia
+#           article](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones). When null, the
+#           project's default time zone is used.
+#       * Updatable via API
+#   
+#   - quiet_mode (string)
+#       * Controls behavior during quiet hours (see quiet_start/quiet_end). Possible values
+#           are 'off' (quiet hours disabled), 'delay' (messages are delayed until quiet hours
+#           end), or 'confirm' (requires manual confirmation to send during quiet hours).
+#       * Allowed values: off, delay, confirm
+#       * Updatable via API
+#   
+#   - quiet_start (string)
+#       * Time of day when quiet hours begin, in HH:MM format (24-hour time) in the phone's
+#           time zone. Messages sent during quiet hours are delayed or require confirmation
+#           depending on quiet_mode. Only applicable when quiet_mode is not 'off'.
+#       * Updatable via API
+#   
+#   - quiet_end (string)
+#       * Time of day when quiet hours end, in HH:MM format (24-hour time) in the phone's time
+#           zone. Messages sent during quiet hours are delayed or require confirmation depending
+#           on quiet_mode. Only applicable when quiet_mode is not 'off'.
+#       * Updatable via API
+#   
 #   - battery (int)
 #       * Current battery level, on a scale from 0 to 100, as of the last time the phone
 #           connected to Telerivet (only present for Android phones)
@@ -104,6 +161,40 @@ module Telerivet
 #           increase this limit, install additional SMS expansion packs in the Telerivet Gateway
 #           app. (only present for Android phones)
 #       * Read-only
+#   
+#   - external_account_id (string)
+#       * Account ID for the external API (e.g. Twilio Account SID, Vonage API Key). Only
+#           present for routes that support external API configuration. See
+#           [createPhone](#Project.createPhone) for the meaning of this field for each phone type.
+#       * Updatable via API
+#   
+#   - external_id (string)
+#       * External phone/resource ID within the external API account (if applicable). Only
+#           present for routes that support external API configuration.
+#       * Updatable via API
+#   
+#   - external_config (Hash)
+#       * Additional configuration settings specific to the phone_type. Only present for
+#           routes that support external API configuration. See
+#           [createPhone](#Project.createPhone) for available settings for each phone type.
+#       * Updatable via API
+#   
+#   - external_setup (Hash)
+#       * Configuration info for routes that require manual webhook setup. Only present for
+#           routes that require manual configuration of callback URLs with the external provider.
+#           Contains URL properties for each webhook type that needs to be configured (e.g.,
+#           `incoming_message_url`, `message_status_url`, `incoming_call_url`).
+#       * Read-only
+#   
+#   - external_secret (string)
+#       * Secret/API key for the external API (e.g. Twilio Auth Token, Vonage API Secret).
+#           Only applicable for routes that support external API configuration. Write-only; not
+#           returned by the API when retrieving a phone.
+#       * Updatable via API
+#   
+#   - url
+#       * URL to this phone in the Telerivet web app
+#       * Read-only
 #
 class Phone < Entity
     #
@@ -123,7 +214,7 @@ class Phone < Entity
     #     - source
     #         * Filter messages by source
     #         * Allowed values: phone, provider, web, api, service, webhook, scheduled,
-    #             integration
+    #             integration, mcp
     #     
     #     - starred (bool)
     #         * Filter messages by starred/unstarred
@@ -195,6 +286,15 @@ class Phone < Entity
         super
     end
 
+    #
+    # Resets this route's sent_message_count to 0 and updates sent_message_epoch to the current
+    # time. If sending was automatically paused because the previous count reached the limit,
+    # sending will be resumed.
+    #
+    def reset_sent_message_count()
+        @api.do_request("POST", get_base_api_path() + "/reset_sent_message_count")
+    end
+
     def id
         get('id')
     end
@@ -243,6 +343,78 @@ class Phone < Entity
         get('project_id')
     end
 
+    def validate_recipient_numbers
+        get('validate_recipient_numbers')
+    end
+
+    def validate_recipient_numbers=(value)
+        set('validate_recipient_numbers', value)
+    end
+
+    def allowed_recipient_countries
+        get('allowed_recipient_countries')
+    end
+
+    def allowed_recipient_countries=(value)
+        set('allowed_recipient_countries', value)
+    end
+
+    def sent_message_limit
+        get('sent_message_limit')
+    end
+
+    def sent_message_limit=(value)
+        set('sent_message_limit', value)
+    end
+
+    def sent_message_count
+        get('sent_message_count')
+    end
+
+    def sent_message_epoch
+        get('sent_message_epoch')
+    end
+
+    def send_delay
+        get('send_delay')
+    end
+
+    def send_delay=(value)
+        set('send_delay', value)
+    end
+
+    def timezone_id
+        get('timezone_id')
+    end
+
+    def timezone_id=(value)
+        set('timezone_id', value)
+    end
+
+    def quiet_mode
+        get('quiet_mode')
+    end
+
+    def quiet_mode=(value)
+        set('quiet_mode', value)
+    end
+
+    def quiet_start
+        get('quiet_start')
+    end
+
+    def quiet_start=(value)
+        set('quiet_start', value)
+    end
+
+    def quiet_end
+        get('quiet_end')
+    end
+
+    def quiet_end=(value)
+        set('quiet_end', value)
+    end
+
     def battery
         get('battery')
     end
@@ -279,6 +451,46 @@ class Phone < Entity
         get('send_limit')
     end
 
+    def external_account_id
+        get('external_account_id')
+    end
+
+    def external_account_id=(value)
+        set('external_account_id', value)
+    end
+
+    def external_id
+        get('external_id')
+    end
+
+    def external_id=(value)
+        set('external_id', value)
+    end
+
+    def external_config
+        get('external_config')
+    end
+
+    def external_config=(value)
+        set('external_config', value)
+    end
+
+    def external_setup
+        get('external_setup')
+    end
+
+    def external_secret
+        get('external_secret')
+    end
+
+    def external_secret=(value)
+        set('external_secret', value)
+    end
+
+    def url
+        get('url')
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/phones/#{get('id')}"
     end