telerivet 1.8.2 → 1.8.5

data/lib/telerivet/project.rb

@@ -41,6 +41,17 @@ module Telerivet
 #           contact.
 #       * Updatable via API
 #   
+#   - message_retention_days (int)
+#       * Number of days to retain messages in this project. Messages older than this will be
+#           automatically deleted. If null, messages will be retained forever.
+#       * Updatable via API
+#   
+#   - short_link_scheme (bool)
+#       * If true (the default), short links in messages will include the scheme (e.g.,
+#           'https://rvt.me/xxxxxxxxx'). If false, short links will not include the scheme (e.g.,
+#           'rvt.me/xxxxxxxxx').
+#       * Updatable via API
+#   
 #   - vars (Hash)
 #       * 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 _.
@@ -93,7 +104,9 @@ class Project < Entity
     #     
     #     - replace_variables (bool)
     #         * Set to true to evaluate variables like [[contact.name]] in message content. [(See
-    #             available variables)](#variables) (`is_template` parameter also accepted)
+    #             available variables)](#variables) (`is_template` parameter also accepted). The
+    #             double square brackets may also include [filters](/api/rules_engine#filters) to
+    #             transform variables, such as to set a default value.
     #         * Default: false
     #     
     #     - track_clicks (boolean)
@@ -115,7 +128,7 @@ class Project < Entity
     #             destination URL.
     #             If null, the short links will not expire.
     #     
-    #     - media_urls (array)
+    #     - media_urls (array of strings)
     #         * 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).
@@ -266,7 +279,7 @@ class Project < Entity
     #             destination URL.
     #             If null, the short links will not expire.
     #     
-    #     - media_urls (array)
+    #     - media_urls (array of strings)
     #         * 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).
@@ -395,7 +408,7 @@ class Project < Entity
     #             destination URL.
     #             If null, the short links will not expire.
     #     
-    #     - media_urls (array)
+    #     - media_urls (array of strings)
     #         * 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).
@@ -497,7 +510,7 @@ class Project < Entity
     # should be provided.
     # 
     # With `message_type`=`service`, schedules an automated service (such
-    # as a poll) to be invoked for a group or list of phone numbers. Any service that can be
+    # as a poll) to be invoked for a group or an individual contact. Any service that can be
     # triggered for a contact can be scheduled via this method, whether or not the service
     # actually sends a message.
     # 
@@ -591,7 +604,7 @@ class Project < Entity
     #             (`is_template` parameter also accepted)
     #         * Default: false
     #     
-    #     - media_urls (array)
+    #     - media_urls (array of strings)
     #         * 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).
@@ -767,7 +780,7 @@ class Project < Entity
     #         * Set to true to evaluate variables like [[contact.name]] in message content
     #         * Default: false
     #     
-    #     - media_urls (array)
+    #     - media_urls (array of strings)
     #         * 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).
@@ -1171,6 +1184,204 @@ class Project < Entity
         return Phone.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
 
+    #
+    # Creates a new basic route (phone) with external API credentials.
+    # 
+    # For some external API providers, this method automatically updates webhook URLs configured
+    # with the external provider so that incoming messages/calls and call status events are routed
+    # to Telerivet. In this case, if you have already configured a webhook URL with the external
+    # provider, it will be overwritten. For other external API providers, webhook URLs may require
+    # manual configuration in order for the route to be fully functional.
+    # 
+    # Note: This API can only create routes that connect to external gateway APIs using your own
+    # account credentials. To add Android phones, WhatsApp routes, or routes with
+    # Telerivet-managed billing, use the web app instead.
+    # 
+    # Credentials are passed via the `external_account_id`, `external_id`, `external_secret`, and
+    # `external_config` parameters. The meaning of these parameters for each phone type is as
+    # follows:
+    # 
+    # **Twilio Virtual Number** (`phone_type`: twilio):
+    # 
+    # - `external_id` (optional): The SID of your Twilio phone number (starts with 'PN'); if not
+    # provided, it will be looked up by the phone_number parameter
+    # - `external_account_id` (required): Your Twilio Account SID (starts with 'AC')
+    # - `external_secret` (required): Your Twilio Auth Token
+    # 
+    # **Twilio Messaging Service** (`phone_type`: twilio_messaging_service):
+    # 
+    # - `external_id` (required): The SID of your Twilio messaging service (starts with 'MG')
+    # - `external_account_id` (required): Your Twilio Account SID (starts with 'AC')
+    # - `external_secret` (required): Your Twilio Auth Token
+    # 
+    # **Twilio Shortcode** (`phone_type`: twilio_shortcode):
+    # 
+    # - `external_id` (optional): The SID of your Twilio shortcode (starts with 'SC'); if not
+    # provided, it will be looked up by the phone_number parameter
+    # - `external_account_id` (required): Your Twilio Account SID (starts with 'AC')
+    # - `external_secret` (required): Your Twilio Auth Token
+    # 
+    # **Twilio Caller ID** (`phone_type`: twilio_caller_id):
+    # 
+    # - `external_account_id` (required): Your Twilio Account SID (starts with 'AC')
+    # - `external_secret` (required): Your Twilio Auth Token
+    # 
+    # **Vonage Virtual Number or Vonage Sender ID** (`phone_type`: nexmo or nexmo_sender_id):
+    # 
+    # - `external_account_id` (required): Your Vonage API Key
+    # - `external_secret` (required): Your Vonage API Secret
+    # 
+    # **Telesign SMS** (`phone_type`: telesign):
+    # 
+    # - `external_account_id` (required): Your Telesign Customer ID
+    # - `external_secret` (required): Your Telesign API Key
+    # - `external_config.message_type`: `ARN`, `MKT`, or `OTP`
+    # - `external_config.sender_type`: `one_way` (default) or `two_way`
+    # 
+    # **Infobip SMS** (`phone_type`: infobip):
+    # 
+    # - `external_account_id` (required): Your Infobip username
+    # - `external_secret` (required): Your Infobip API key
+    # - `external_config.sender_type`: `one_way` (default) or `two_way`
+    # - `external_config.india_dlt_principal_entity_id`: India DLT Principal Entity ID (only
+    # needed if sending to India)
+    # 
+    # **Infobip USSD** (`phone_type`: infobip_ussd):
+    # 
+    # - No external credentials required
+    # 
+    # **Africa's Talking SMS** (`phone_type`: africas_talking):
+    # 
+    # - `external_account_id` (required): Your Africa's Talking username
+    # - `external_secret` (required): Your Africa's Talking API key
+    # - `external_config.sender_type`: `one_way` (default) or `two_way`
+    # 
+    # **Africa's Talking USSD** (`phone_type`: africas_talking_ussd):
+    # 
+    # - No external credentials required
+    # 
+    # **Simulated Phone** (`phone_type`: simulated):
+    # 
+    # - No external credentials required
+    # - Messages are simulated locally and not sent to any external provider
+    # - Useful for testing
+    # 
+    # #### Webhook URL Setup
+    # 
+    # Some route types require manual configuration of callback URLs in the external provider's
+    # dashboard. When the Phone response includes an `external_setup` object, you will need to
+    # configure the webhook URLs in your provider's account settings.
+    # 
+    # The following phone types require manual webhook setup:
+    # 
+    # - `africas_talking`: `message_status_url` (always), `incoming_message_url` (if two_way)
+    # - `africas_talking_ussd`: `incoming_call_url`
+    # - `infobip_ussd`: `incoming_call_url`
+    # - `twilio_messaging_service`: `incoming_message_url`
+    # - `telesign` (two_way only): `incoming_message_url`
+    # 
+    # Telerivet automatically configures webhooks for the following phone types as follows:
+    # 
+    # - `twilio` - automatically updates incoming SMS and voice configuration for the Twilio
+    # virtual number associated with the phone_number or external_id parameter
+    # - `twilio_shortcode` - automatically updates incoming SMS configuration for the Twilio short
+    # code associated with the phone_number or external_id parameter
+    # - `nexmo` - automatically updates incoming SMS and voice configuration for the Vonage
+    # virtual number matching the phone_number parameter
+    # - `infobip` - automatically updates incoming SMS configuration for the Infobip virtual
+    # number matching the phone_number parameter or external_id parameter
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - name (string)
+    #         * Name of the basic route to create
+    #     
+    #     - phone_number (string)
+    #         * Phone number or sender ID
+    #         * Required
+    #     
+    #     - phone_type (string)
+    #         * Type of basic route to create. Supported values: twilio, twilio_messaging_service,
+    #             twilio_shortcode, twilio_caller_id, nexmo, infobip, africas_talking,
+    #             africas_talking_ussd, infobip_ussd, telesign, simulated. Other types of basic routes
+    #             can only be created via the web app.
+    #         * Required
+    #     
+    #     - external_account_id (string)
+    #         * Account ID for the external API (e.g. Twilio Account SID, Vonage API Key). See the
+    #             description above for the meaning of this parameter for each phone type.
+    #     
+    #     - external_id (string)
+    #         * External phone/resource ID within the external API account (if applicable). For
+    #             `twilio` and `twilio_shortcode` routes, this is optional and will be looked up
+    #             automatically from the phone_number if not provided.
+    #     
+    #     - external_secret (string)
+    #         * Secret/API key for the external API (e.g. Twilio Auth Token, Vonage API Secret).
+    #             This value is required when creating a new route but is never returned in API
+    #             responses. See the description above for the meaning of this parameter for each
+    #             phone type.
+    #     
+    #     - external_config (Hash)
+    #         * Additional configuration settings specific to the phone_type. See the description
+    #             above for available settings for each phone type.
+    #     
+    #     - country
+    #         * 2-letter country code (ISO 3166-1 alpha-2) where phone is from. This country code
+    #             is used to automatically convert phone numbers in local format to international
+    #             format. If not provided, will be set to the organization's country by default.
+    #     
+    #     - send_paused (bool)
+    #         * True if sending messages should initially be paused, false otherwise
+    #         * Default:
+    #     
+    #     - timezone_id (string)
+    #         * A string specifying the time zone used when sending messages; see [List of tz
+    #             database time zones Wikipedia
+    #             article](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones). When not
+    #             provided, the project's default time zone is used.
+    #     
+    #     - validate_recipient_numbers (bool)
+    #         * Set to true to validate recipient phone numbers before sending. Messages to
+    #             invalid numbers will fail without being sent.
+    #         * Default:
+    #     
+    #     - 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. If not provided, there is no restriction.
+    #     
+    #     - send_delay (number)
+    #         * Number of seconds to wait after sending each message, to avoid exceeding carrier
+    #             rate limits.
+    #     
+    #     - quiet_mode (string)
+    #         * Controls behavior during quiet hours. Possible values: 'off' (disabled), 'delay'
+    #             (messages delayed until quiet hours end), 'confirm' (requires manual confirmation;
+    #             worker-based routes only).
+    #         * Allowed values: off, delay, confirm
+    #         * Default: off
+    #     
+    #     - quiet_start (string)
+    #         * Time when quiet hours begin, in HH:MM format (24-hour time). Only applicable when
+    #             quiet_mode is not 'off'.
+    #     
+    #     - quiet_end (string)
+    #         * Time when quiet hours end, in HH:MM format (24-hour time). Only applicable when
+    #             quiet_mode is not 'off'.
+    #     
+    #     - vars
+    #         * Custom variables and values to set for this basic route
+    #   
+    # Returns:
+    #     Telerivet::Phone
+    #
+    def create_phone(options)
+        require_relative 'phone'
+        Phone.new(@api, @api.do_request("POST", get_base_api_path() + "/phones", options))
+    end
+
     #
     # Queries messages within the given project.
     # 
@@ -1823,6 +2034,122 @@ class Project < Entity
         return Label.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
 
+    #
+    # Queries message templates within the given project.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #     
+    #     - name
+    #         * Filter templates by name
+    #         * Allowed modifiers: name[ne], name[prefix], name[not_prefix], name[gte], name[gt],
+    #             name[lt], name[lte]
+    #     
+    #     - waba_id
+    #         * Filter templates by WhatsApp Business Account ID
+    #     
+    #     - sort
+    #         * Sort the results based on a field
+    #         * Allowed values: default, name
+    #         * Default: default
+    #     
+    #     - sort_dir
+    #         * Sort the results in ascending or descending order
+    #         * Allowed values: asc, desc
+    #         * Default: asc
+    #     
+    #     - page_size (int)
+    #         * Number of results returned per page (max 500)
+    #         * Default: 50
+    #     
+    #     - offset (int)
+    #         * Number of items to skip from beginning of result set
+    #         * Default: 0
+    #   
+    # Returns:
+    #     Telerivet::APICursor (of Telerivet::MessageTemplate)
+    #
+    def query_message_templates(options = nil)
+        require_relative 'messagetemplate'
+        @api.cursor(MessageTemplate, get_base_api_path() + "/message_templates", options)
+    end
+
+    #
+    # Creates a new message template that can be used when composing or scheduling messages.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - name (string)
+    #         * Name of the template (max 127 characters)
+    #         * Required
+    #     
+    #     - content (string)
+    #         * Content of the message template (max 2000 characters)
+    #         * Required
+    #     
+    #     - track_clicks (bool)
+    #         * If true, URLs in the content will be replaced with short links that track clicks.
+    #             Requires a plan with click tracking enabled.
+    #         * Default:
+    #     
+    #     - short_link_params (Hash)
+    #         * If `track_clicks` is true, `short_link_params` may be used to specify custom
+    #             parameters for each short link.
+    #     
+    #     - attachments (array)
+    #         * List of attachment objects with file URLs to include with the template
+    #     
+    #     - route_params (Hash)
+    #         * Route-specific parameters to use when sending messages with this template.
+    #             
+    #             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).
+    #   
+    # Returns:
+    #     Telerivet::MessageTemplate
+    #
+    def create_message_template(options)
+        require_relative 'messagetemplate'
+        MessageTemplate.new(@api, @api.do_request("POST", get_base_api_path() + "/message_templates", options))
+    end
+
+    #
+    # Retrieves the message template with the given ID.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the message template
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::MessageTemplate
+    #
+    def get_message_template_by_id(id)
+        require_relative 'messagetemplate'
+        MessageTemplate.new(@api, @api.do_request("GET", get_base_api_path() + "/message_templates/#{id}"))
+    end
+
+    #
+    # Initializes the message template with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the message template
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::MessageTemplate
+    #
+    def init_message_template_by_id(id)
+        require_relative 'messagetemplate'
+        return MessageTemplate.new(@api, {'project_id' => self.id, 'id' => id}, false)
+    end
+
     #
     # Queries data tables within the given project.
     # 
@@ -2065,19 +2392,144 @@ class Project < Entity
         return RelativeScheduledMessage.new(@api, {'project_id' => self.id, 'id' => id}, false)
     end
 
+    #
+    # Queries scheduled services within the given project.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #     
+    #     - service_id
+    #         * Filter scheduled services by the service ID
+    #     
+    #     - time_created (UNIX timestamp)
+    #         * Filter scheduled services by time_created
+    #         * Allowed modifiers: time_created[min], time_created[max]
+    #     
+    #     - next_time (UNIX timestamp)
+    #         * Filter scheduled services by next_time
+    #         * Allowed modifiers: next_time[min], next_time[max]
+    #     
+    #     - sort
+    #         * Sort the results based on a field
+    #         * Allowed values: default, next_time
+    #         * Default: default
+    #     
+    #     - sort_dir
+    #         * Sort the results in ascending or descending order
+    #         * Allowed values: asc, desc
+    #         * Default: asc
+    #     
+    #     - page_size (int)
+    #         * Number of results returned per page (max 500)
+    #         * Default: 50
+    #     
+    #     - offset (int)
+    #         * Number of items to skip from beginning of result set
+    #         * Default: 0
+    #   
+    # Returns:
+    #     Telerivet::APICursor (of Telerivet::ScheduledService)
+    #
+    def query_scheduled_services(options = nil)
+        require_relative 'scheduledservice'
+        @api.cursor(ScheduledService, get_base_api_path() + "/scheduled_services", options)
+    end
+
+    #
+    # Schedules a service to be triggered at a specified time.
+    # 
+    # Only services that can be triggered for the project context and
+    # handle the default event can be scheduled. This includes services with types
+    # `scheduled_actions`, `scheduled_script`, and other service types that support project-level
+    # triggering.
+    # 
+    # (Note: To schedule services that are triggered for a contact,
+    # [project.scheduleMessage](#Project.scheduleMessage) should be used instead with
+    # `message_type`=`service`.)
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - service_id
+    #         * ID of the service to schedule
+    #         * Required
+    #     
+    #     - start_time (UNIX timestamp)
+    #         * The time that the service will be triggered (or first triggered for recurring
+    #             scheduled services)
+    #         * Required if start_time_offset not set
+    #     
+    #     - start_time_offset (int)
+    #         * Number of seconds from now to trigger the service
+    #     
+    #     - rrule
+    #         * A recurrence rule describing how the schedule repeats, e.g. 'FREQ=MONTHLY' or
+    #             'FREQ=WEEKLY;INTERVAL=2'; see <https://tools.ietf.org/html/rfc2445#section-4.3.10>.
+    #             (UNTIL is ignored; use end_time parameter instead).
+    #         * Default: COUNT=1 (one-time scheduled service, does not repeat)
+    #     
+    #     - timezone_id
+    #         * TZ database timezone ID; see [List of tz database time zones Wikipedia
+    #             article](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+    #         * Default: project default timezone
+    #     
+    #     - end_time (UNIX timestamp)
+    #         * Time after which a recurring scheduled service will stop (not applicable to
+    #             non-recurring scheduled services)
+    #     
+    #     - end_time_offset (int)
+    #         * Number of seconds from now until the recurring scheduled service will stop
+    #     
+    #     - vars (Hash)
+    #         * Custom variables to store for this scheduled service
+    #   
+    # Returns:
+    #     Telerivet::ScheduledService
+    #
+    def schedule_service(options)
+        require_relative 'scheduledservice'
+        ScheduledService.new(@api, @api.do_request("POST", get_base_api_path() + "/scheduled_services", options))
+    end
+
+    #
+    # Retrieves the scheduled service with the given ID.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the scheduled service
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::ScheduledService
+    #
+    def get_scheduled_service_by_id(id)
+        require_relative 'scheduledservice'
+        ScheduledService.new(@api, @api.do_request("GET", get_base_api_path() + "/scheduled_services/#{id}"))
+    end
+
+    #
+    # Initializes the scheduled service with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the scheduled service
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::ScheduledService
+    #
+    def init_scheduled_service_by_id(id)
+        require_relative 'scheduledservice'
+        return ScheduledService.new(@api, {'project_id' => self.id, 'id' => id}, false)
+    end
+
     #
     # Creates a new automated service.
     # 
     # Only certain types of automated services can be created via the API.
     # Other types of services can only be created via the web app.
     # 
-    # Although Custom Actions services cannot be created directly via the
-    # API, they may be converted to a template,
-    # and then instances of the template can be created via this method
-    # with `service_type`=`custom_template_instance`. Converting a service
-    # to a template requires the Service Templates feature to be enabled
-    # for the organization.
-    # 
     # Arguments:
     #   - options (Hash)
     #       * Required
@@ -2090,63 +2542,37 @@ class Project < Entity
     #         * Type of service to create.  The following service types can be created via the
     #             API:
     #             
+    #             - incoming_message_actions
+    #             - contact_actions
+    #             - message_actions
+    #             - project_actions
+    #             - message_status_actions
+    #             - voice_actions
+    #             - ussd_actions
+    #             - data_row_actions
     #             - incoming_message_webhook
     #             - messaging_poll
+    #             - scheduled_actions
     #             - incoming_message_script
     #             - contact_script
     #             - message_script
     #             - data_row_script
+    #             - scheduled_script
     #             - webhook_script
     #             - voice_script
     #             - ussd_script
     #             - project_script
+    #             - opt_out_page
+    #             - button_page
     #             - custom_template_instance
     #             
     #             Other types of services can only be created via the web app.
     #         * Required
     #     
     #     - config (Hash)
-    #         * Configuration specific to the service `type`.
-    #             
-    #             **incoming_message_webhook**:
-    #             <table>
-    #             <tr><td> url </td> <td> The webhook URL that will be
-    #             triggered when an incoming message is received (string) </td></tr>
-    #             <tr><td> secret </td> <td> Optional string that will
-    #             be passed as the `secret` POST parameter to the webhook URL. (object) </td></tr>
-    #             </table>
-    #             <br />
-    #             
-    #             **incoming_message_script, contact_script,
-    #             message_script, data_row_script, webhook_script, voice_script, ussd_script,
-    #             project_script**:
-    #             <table>
-    #             <tr><td> code </td> <td> The JavaScript code to run
-    #             when the service is triggered (max 100 KB). To run code longer than 100 KB, use a
-    #             Cloud Script Module. (string) </td></tr>
-    #             </table>
-    #             <br />
-    #             
-    #             **custom_template_instance**:
-    #             <table>
-    #             <tr><td> template_service_id </td> <td> ID of the
-    #             service template (string). The service template must be available to the current
-    #             project or organization.</td></tr>
-    #             <tr><td> params </td> <td> Key/value pairs for all
-    #             service template parameters (object). If the values satisfy the validation rules
-    #             specified in the service template, they will also be copied to the `vars` property
-    #             of the service. Any values not associated with service template parameters will be
-    #             ignored.
-    #             </td></tr>
-    #             </table>
-    #             <br />
-    #             
-    #             **messaging_poll**:
-    #             <br />
-    #             The configuration parameters for poll services are
-    #             not yet documented, but can be determined by creating a poll via the web app and
-    #             then retrieving the configuration via [service.getConfig](#Service.getConfig).
-    #             <br />
+    #         * Configuration specific to the `service_type`. See [Service Configuration
+    #             Reference](#service_config) for complete documentation of configuration parameters
+    #             for each service type.
     #         * Required
     #     
     #     - vars
@@ -2176,7 +2602,21 @@ class Project < Entity
     #     - message_types (array)
     #         * Types of messages that this service should handle. Only applies to services that
     #             handle incoming messages.
-    #         * Allowed values: text, call, sms, mms, ussd_session, chat
+    #         * Allowed values: text, call, ussd
+    #     
+    #     - table_ids (array)
+    #         * IDs of data tables that this service applies to, or null to apply to all data
+    #             tables. Only applies to data row services (`data_row_script` and
+    #             `data_row_actions`).
+    #     
+    #     - message_statuses (array of strings)
+    #         * Message statuses that this service should handle. Only applies to
+    #             `message_status_actions` services.
+    #         * Allowed values: sent, delivered, failed, failed_queued, not_delivered
+    #     
+    #     - tags (array of strings)
+    #         * Tags used to organize this service. Each tag can be up to 32 characters in length,
+    #             and up to 10 tags are allowed.
     #     
     #     - show_action (bool)
     #         * Whether to show this service in the Actions menu within the Telerivet web app when
@@ -2235,7 +2675,8 @@ class Project < Entity
     #     
     #     - context
     #         * Filter services that can be invoked in a particular context
-    #         * Allowed values: message, call, ussd_session, row, contact, project
+    #         * Allowed values: message, call, ussd_session, row, contact, project,
+    #             airtime_transaction
     #     
     #     - sort
     #         * Sort the results based on a field
@@ -2440,6 +2881,37 @@ class Project < Entity
         @api.cursor(Route, get_base_api_path() + "/routes", options)
     end
 
+    #
+    # Creates a new custom route that can be used to send messages via one or more basic routes
+    # (phones).
+    # 
+    # The `actions` array defines the routing rules.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - name (string)
+    #         * Name of the custom route to create
+    #         * Required
+    #     
+    #     - actions (array of RoutingAction)
+    #         * Array of routing action objects. Allowed action types: `use_phone` (select basic
+    #             routes to send messages), `condition` (conditionally execute actions based on
+    #             criteria).
+    #         * Required
+    #     
+    #     - vars
+    #         * Custom variables and values to set for this route
+    #   
+    # Returns:
+    #     Telerivet::Route
+    #
+    def create_route(options)
+        require_relative 'route'
+        Route.new(@api, @api.do_request("POST", get_base_api_path() + "/routes", options))
+    end
+
     #
     # Gets a custom route by ID
     # 
@@ -2565,9 +3037,9 @@ class Project < Entity
 
     #
     # 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.)
+    # an array of objects with the properties 'name', 'variable', 'type', 'order', 'readonly',
+    # 'lookup_key', and 'show_on_conversation'. (Fields are automatically created any time a
+    # Contact's 'vars' property is updated.)
     # 
     # Returns:
     #     array
@@ -2603,9 +3075,9 @@ class Project < Entity
     #     
     #     - 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`
+    #             show when type is `select` or `radio`. Each `value` and `label` must be between 1
+    #             and 256 characters in length.
+    #         * Required if type is `select` or `radio`
     #     
     #     - readonly (bool)
     #         * Set to true to prevent editing the field in the Telerivet web app
@@ -2626,8 +3098,8 @@ class Project < Entity
 
     #
     # 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
+    # an array of objects with the properties 'name', 'variable', 'type', 'order', and
+    # 'hide_values'. (Fields are automatically created any time a Message's 'vars' property is
     # updated.)
     # 
     # Returns:
@@ -2664,9 +3136,9 @@ class Project < Entity
     #     
     #     - 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`
+    #             show when type is `select` or `radio`. Each `value` and `label` must be between 1
+    #             and 256 characters in length.
+    #         * Required if type is `select` or `radio`
     #     
     #     - hide_values (bool)
     #         * Set to true to avoid showing values of this field on the Messages page
@@ -2680,8 +3152,9 @@ class Project < Entity
 
     #
     # 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.
+    # historical data that is computed shortly after midnight each day in the project's time zone.
+    # If the date range includes the current day, it will include statistics for the current day
+    # so far.
     # 
     # Arguments:
     #   - options (Hash)
@@ -2729,35 +3202,110 @@ class Project < Entity
     #       - 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 webhooks within the given project.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #     
+    #     - sort
+    #         * Sort the results based on a field
+    #         * Allowed values: default
+    #         * Default: default
+    #     
+    #     - sort_dir
+    #         * Sort the results in ascending or descending order
+    #         * Allowed values: asc, desc
+    #         * Default: asc
+    #     
+    #     - page_size (int)
+    #         * Number of results returned per page (max 500)
+    #         * Default: 50
+    #     
+    #     - offset (int)
+    #         * Number of items to skip from beginning of result set
+    #         * Default: 0
+    #   
+    # Returns:
+    #     Telerivet::APICursor (of Telerivet::Webhook)
+    #
+    def query_webhooks(options = nil)
+        require_relative 'webhook'
+        @api.cursor(Webhook, get_base_api_path() + "/webhooks", options)
+    end
+
+    #
+    # Creates a new webhook that will be triggered when specific events occur within the project.
+    # 
+    # Note: The Webhook object is not used for notifying your server when
+    # incoming messages are received. To notify a URL when incoming messages are received, you can
+    # configure a webhook by [creating a Service](#Project.createService) with type
+    # incoming_message_webhook.
+    # 
+    # Arguments:
+    #   - options (Hash)
+    #       * Required
+    #     
+    #     - url
+    #         * URL to send webhook requests to. Must start with https:// or http://.
+    #         * Required
+    #     
+    #     - secret
+    #         * Secret to include when sending webhook requests (up to 200 characters). Telerivet
+    #             will send the secret in the password field of HTTP basic auth (with username
+    #             'telerivet').
+    #     
+    #     - events (array of strings)
+    #         * Array of event types to trigger this webhook. Valid event types are: `send_status`
+    #             (message status updates), `send_broadcast` (broadcast sent), `contact_update`
+    #             (contact added/updated/deleted), `message_metadata` (message metadata updated).
+    #   
+    # Returns:
+    #     Telerivet::Webhook
+    #
+    def create_webhook(options)
+        require_relative 'webhook'
+        Webhook.new(@api, @api.do_request("POST", get_base_api_path() + "/webhooks", options))
+    end
+
+    #
+    # Retrieves the webhook with the given ID.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the webhook
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Webhook
+    #
+    def get_webhook_by_id(id)
+        require_relative 'webhook'
+        Webhook.new(@api, @api.do_request("GET", get_base_api_path() + "/webhooks/#{id}"))
+    end
+
+    #
+    # Initializes the webhook with the given ID without making an API request.
+    # 
+    # Arguments:
+    #   - id
+    #       * ID of the webhook
+    #       * Required
+    #   
+    # Returns:
+    #     Telerivet::Webhook
+    #
+    def init_webhook_by_id(id)
+        require_relative 'webhook'
+        return Webhook.new(@api, {'project_id' => self.id, 'id' => id}, false)
+    end
+
     #
     # Saves any fields or custom variables that have changed for the project.
     #
@@ -2809,6 +3357,22 @@ class Project < Entity
         set('auto_create_contacts', value)
     end
 
+    def message_retention_days
+        get('message_retention_days')
+    end
+
+    def message_retention_days=(value)
+        set('message_retention_days', value)
+    end
+
+    def short_link_scheme
+        get('short_link_scheme')
+    end
+
+    def short_link_scheme=(value)
+        set('short_link_scheme', value)
+    end
+
     def organization_id
         get('organization_id')
     end