telerivet 1.8.5 → 1.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa70ed97588b66c3d7fd0d24005b2403babaadec99e991282932c2affb0235dc
-  data.tar.gz: 8ba55152dbe5c5a4fe721de7c1eb4736d0c11ae67085f15c8a45d44489553184
+  metadata.gz: 34e9871ede25de1cdf8bfe1c005fe4e8e60379bdc69248ad5970c12f50c38e0c
+  data.tar.gz: 61ad68fa5fb5b4330007e22771b48246bf77b21896b63fde13f3ee78d7a3fc34
 SHA512:
-  metadata.gz: ffeac3152f1a8138fd00a43887c17a67a694472f4b66631735f6c71d106d55c56280cf0170b944700ede23c4b4c84718b1eaf92e1ddec92c3922355cc5322112
-  data.tar.gz: 433530a39c90af7ac38e49f093e3a77e91c11777987b4bc0de1b8fd4b013bb798e1d02d8a2a3332a3fc87b34c048680090714f6b2a90ba63bfd440f0ed4d9918
+  metadata.gz: 32711fe64279b39a08a3de779cfa390e2e2089259f79a486b6cddf81e6d7d659a1767c7362753aac38bd68f18077e4f1bf13b6f24a6c308805189787d17bc0e3
+  data.tar.gz: 4ed7248b9c7a3ee4e47daae81ee614ce249f52701c872227723b892a89c740a814f4daf1c0f403e55ad8280430b2f0cf644c951d31d4f1cb192d128d2ecb1407

data/lib/telerivet/airtimetransaction.rb

@@ -2,7 +2,8 @@
 module Telerivet
 
 #
-# Represents a transaction where airtime is sent to a mobile phone number.
+# Represents a transaction where airtime is sent to a mobile phone number. This also is used
+# to represent non-airtime value transfers such as data bundles or gift cards.
 # 
 # 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),

data/lib/telerivet/broadcast.rb

@@ -115,7 +115,8 @@ module Telerivet
 #   
 #   - source
 #       * How the message originated within Telerivet
-#       * Allowed values: phone, provider, web, api, service, webhook, scheduled, integration
+#       * Allowed values: phone, provider, web, api, service, webhook, scheduled, integration,
+#           mcp
 #       * Read-only
 #   
 #   - simulated (bool)
@@ -139,11 +140,8 @@ module Telerivet
 #       * Read-only
 #   
 #   - media (array)
-#       * For text messages containing media files, this is an array of objects with the
-#           properties `url`, `type` (MIME type), `filename`, and `size` (file size in bytes).
-#           Unknown properties are null. This property is undefined for messages that do not
-#           contain media files. Note: For files uploaded via the Telerivet web app, the URL is
-#           temporary and may not be valid for more than 1 day.
+#       * Array of media attachments for the text message. This property is undefined for
+#           messages that do not contain media files.
 #       * Read-only
 #   
 #   - vars (Hash)
@@ -192,6 +190,10 @@ module Telerivet
 #           call flow)
 #       * Read-only
 #   
+#   - url
+#       * URL to this broadcast in the Telerivet web app
+#       * Read-only
+#   
 #   - user_id (string, max 34 characters)
 #       * ID of the Telerivet user who sent the broadcast (if applicable)
 #       * Read-only
@@ -345,6 +347,10 @@ class Broadcast < Entity
         get('service_id')
     end
 
+    def url
+        get('url')
+    end
+
     def user_id
         get('user_id')
     end

data/lib/telerivet/campaign.rb

@@ -0,0 +1,481 @@
+
+module Telerivet
+
+#
+# A campaign is something that is sent to a group of contacts on a particular schedule.
+# 
+# Depending on the campaign type, a campaign may send a text message, make a
+# voice call, or trigger an automated service. A campaign may either send a single broadcast
+# at once, or send multiple broadcasts to different contacts over time.
+# 
+# Campaigns are initially created as a draft and can be edited and previewed
+# before being sent. This supports a workflow where campaigns can be drafted via the API, and
+# subsequently edited, approved, and sent via either the web app or the API. Once sent, a
+# campaign creates one or more broadcasts to deliver messages to the target recipients.
+# 
+# Campaigns build on top of other core entity types including broadcasts and
+# scheduled messages. Although it is possible to send broadcasts or schedule messages directly
+# via the API, campaigns can be used in order to provide the ability to save drafts, allow
+# manual editing and approval before sending, or to organize broadcasts within Telerivet.
+# 
+# Fields:
+# 
+#   - id (string, max 34 characters)
+#       * ID of the campaign
+#       * Read-only
+#   
+#   - name
+#       * Name of the campaign, which must be unique within the project. The campaign name is
+#           only visible within Telerivet, and does not appear in the messages sent to contacts.
+#       * Updatable via API
+#   
+#   - campaign_type
+#       * Type of the campaign. The following campaign types are available:
+#           
+#           - `broadcast_text` - Send a text message to a group of contacts
+#           - `broadcast_call` - Send a voice call to a group of contacts
+#           - `broadcast_svc` - Trigger a service for a group of contacts
+#           - `relative` - Send a series of messages over time relative to
+#           when each contact was added to a group
+#           - `anniversary` - Send messages on recurring dates (e.g.
+#           birthdays, anniversaries)
+#       * Allowed values: broadcast_text, broadcast_call, broadcast_svc, relative, anniversary
+#       * Read-only
+#   
+#   - status
+#       * Current status of the campaign
+#       * Allowed values: draft, scheduled, sent, pending_review
+#       * Read-only
+#   
+#   - group_id
+#       * ID of the group of contacts that the campaign will be sent to
+#       * Updatable via API
+#   
+#   - exclude_group_id
+#       * ID of a group of contacts to exclude from the campaign
+#       * Updatable via API
+#   
+#   - route_id
+#       * ID of the phone or route used to send the campaign
+#       * Updatable via API
+#   
+#   - broadcast_id
+#       * ID of the most recent broadcast created by this campaign, if applicable
+#       * Read-only
+#   
+#   - estimated_count (int)
+#       * Estimated number of messages that will be sent in this campaign
+#       * Read-only
+#   
+#   - message_count (int)
+#       * Number of messages that have been sent in this campaign
+#       * Read-only
+#   
+#   - respondent_group_id
+#       * ID of a group to add contacts to after they respond to the campaign
+#       * Updatable via API
+#   
+#   - clicked_group_id
+#       * ID of a group to add contacts to after they click a link in the campaign
+#       * Updatable via API
+#   
+#   - label_ids (array)
+#       * List of IDs of labels applied to messages sent by this campaign
+#       * Updatable via API
+#   
+#   - schedule_mode
+#       * Indicates whether the campaign should be sent immediately or at a future time
+#           (applies to broadcast campaign types). If `schedule_time` is set, `schedule_mode` is
+#           automatically set to `at_time`. If `schedule_mode` is set to `immediate` or `null`,
+#           `schedule_time` is automatically cleared.
+#           
+#           Note that after setting schedule_mode to "immediate" on a campaign
+#           with the `draft` status, the campaign will not actually be sent until the API method
+#           is called to [send the campaign](#Campaign.send).
+#       * Allowed values: immediate, at_time
+#       * Updatable via API
+#   
+#   - schedule_time (UNIX timestamp)
+#       * The time to send the campaign, as a UNIX timestamp (applies to broadcast campaign
+#           types). Setting this to a non-null value automatically sets `schedule_mode` to
+#           `at_time`.
+#           
+#           Note that after setting schedule_time on a campaign with the
+#           `draft` status, the campaign will not actually be scheduled until the API method is
+#           called to [schedule the campaign](#Campaign.send).
+#       * Updatable via API
+#   
+#   - content (string)
+#       * Text content of the message (applies to `broadcast_text` campaigns), or the
+#           text-to-speech text for voice calls (applies to `broadcast_call` campaigns). May
+#           contain variables like `[[contact.name]]`.
+#           
+#           [(See available variables)](#variables)
+#       * Updatable via API
+#   
+#   - media (array)
+#       * Array of media attachments (applies to `broadcast_text` campaigns).
+#       * Read-only
+#   
+#   - route_params (Hash)
+#       * Route-specific parameters for the message (applies to `broadcast_text` campaigns).
+#           See [Route-Specific Parameters](#route_params).
+#       * Updatable via API
+#   
+#   - track_clicks (boolean)
+#       * Whether to shorten links and track link clicks (applies to `broadcast_text`
+#           campaigns).
+#       * Updatable via API
+#   
+#   - short_link_params (Hash)
+#       * Parameters for short links when `track_clicks` is enabled (applies to
+#           `broadcast_text` campaigns).
+#       * Updatable via API
+#   
+#   - audio_url
+#       * For voice calls, the URL of an MP3 file to play when the contact answers the call
+#           (applies to `broadcast_call` campaigns)
+#       * Updatable via API
+#   
+#   - tts_lang
+#       * For voice calls, the language of the text-to-speech voice (applies to
+#           `broadcast_call` campaigns)
+#       * Allowed values: en-US, en-GB, en-GB-WLS, en-AU, en-IN, da-DK, nl-NL, fr-FR, fr-CA,
+#           de-DE, is-IS, it-IT, pl-PL, pt-BR, pt-PT, ru-RU, es-ES, es-US, sv-SE
+#       * Updatable via API
+#   
+#   - tts_voice
+#       * For voice calls, the text-to-speech voice (applies to `broadcast_call` campaigns)
+#       * Allowed values: female, male
+#       * Updatable via API
+#   
+#   - service_id
+#       * ID of the service associated with this campaign (applies to `broadcast_call` or
+#           `broadcast_svc` campaigns)
+#       * Read-only
+#   
+#   - date_variable
+#       * Custom contact variable storing date or date/time values relative to which messages
+#           will be scheduled (applies to `relative` and `anniversary` campaigns)
+#       * Updatable via API
+#   
+#   - items (array)
+#       * Array of campaign items (applies to `relative` and `anniversary` campaigns). Each
+#           item defines a scheduled message with timing and content.
+#       * Updatable via API
+#   
+#   - message_type
+#       * Type of messages sent by this campaign, or null if not applicable
+#       * Read-only
+#   
+#   - timezone_id
+#       * The ID of the timezone used for scheduling messages in this campaign, or null to use
+#           the project's default timezone
+#       * Updatable via API
+#   
+#   - time_created (UNIX timestamp)
+#       * Time the campaign was created in Telerivet
+#       * Read-only
+#   
+#   - time_updated (UNIX timestamp)
+#       * Time the campaign was last updated in Telerivet
+#       * Read-only
+#   
+#   - vars (Hash)
+#       * Custom variables stored for this campaign. 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
+#   
+#   - url
+#       * URL to view the campaign in the Telerivet web app
+#       * Read-only
+#   
+#   - url_edit
+#       * URL to edit the campaign in the Telerivet web app
+#       * Read-only
+#   
+#   - url_send
+#       * URL to preview and send the campaign in the Telerivet web app
+#       * Read-only
+#   
+#   - user_id
+#       * ID of the Telerivet user who created the campaign
+#       * Read-only
+#   
+#   - project_id
+#       * ID of the project this campaign belongs to
+#       * Read-only
+#
+class Campaign < Entity
+    #
+    # Saves any fields or custom variables that have changed for this campaign.
+    #
+    def save()
+        super
+    end
+
+    #
+    # Sends or schedules this campaign. The campaign must be in the `draft` or `scheduled` status,
+    # and must be fully configured (e.g. with a group, route, and message content).
+    # 
+    # For broadcast campaigns, this will send the campaign immediately if
+    # the campaign's `schedule_mode` is `immediate`. If `schedule_mode` is `at_time`, it will
+    # schedule the campaign to be sent at the time of the `schedule_time` timestamp.
+    # 
+    # For relative and anniversary campaigns, this will schedule the
+    # campaign according to the configuration in the `items` and `date_variable` properties.
+    # 
+    # Returns:
+    #     Telerivet::Campaign
+    #
+    def send()
+        require_relative 'campaign'
+        Campaign.new(@api, @api.do_request("POST", get_base_api_path() + "/send"))
+    end
+
+    #
+    # Cancels a scheduled campaign, reverting it to the `draft` status. The campaign must be in
+    # the `scheduled` or `pending_review` status.
+    # 
+    # Returns:
+    #     Telerivet::Campaign
+    #
+    def unschedule()
+        require_relative 'campaign'
+        Campaign.new(@api, @api.do_request("POST", get_base_api_path() + "/unschedule"))
+    end
+
+    #
+    # Deletes this campaign. Any scheduled messages will be cancelled.
+    #
+    def delete()
+        @api.do_request("DELETE", get_base_api_path())
+    end
+
+    def id
+        get('id')
+    end
+
+    def name
+        get('name')
+    end
+
+    def name=(value)
+        set('name', value)
+    end
+
+    def campaign_type
+        get('campaign_type')
+    end
+
+    def status
+        get('status')
+    end
+
+    def group_id
+        get('group_id')
+    end
+
+    def group_id=(value)
+        set('group_id', value)
+    end
+
+    def exclude_group_id
+        get('exclude_group_id')
+    end
+
+    def exclude_group_id=(value)
+        set('exclude_group_id', value)
+    end
+
+    def route_id
+        get('route_id')
+    end
+
+    def route_id=(value)
+        set('route_id', value)
+    end
+
+    def broadcast_id
+        get('broadcast_id')
+    end
+
+    def estimated_count
+        get('estimated_count')
+    end
+
+    def message_count
+        get('message_count')
+    end
+
+    def respondent_group_id
+        get('respondent_group_id')
+    end
+
+    def respondent_group_id=(value)
+        set('respondent_group_id', value)
+    end
+
+    def clicked_group_id
+        get('clicked_group_id')
+    end
+
+    def clicked_group_id=(value)
+        set('clicked_group_id', value)
+    end
+
+    def label_ids
+        get('label_ids')
+    end
+
+    def label_ids=(value)
+        set('label_ids', value)
+    end
+
+    def schedule_mode
+        get('schedule_mode')
+    end
+
+    def schedule_mode=(value)
+        set('schedule_mode', value)
+    end
+
+    def schedule_time
+        get('schedule_time')
+    end
+
+    def schedule_time=(value)
+        set('schedule_time', value)
+    end
+
+    def content
+        get('content')
+    end
+
+    def content=(value)
+        set('content', value)
+    end
+
+    def media
+        get('media')
+    end
+
+    def route_params
+        get('route_params')
+    end
+
+    def route_params=(value)
+        set('route_params', value)
+    end
+
+    def track_clicks
+        get('track_clicks')
+    end
+
+    def track_clicks=(value)
+        set('track_clicks', value)
+    end
+
+    def short_link_params
+        get('short_link_params')
+    end
+
+    def short_link_params=(value)
+        set('short_link_params', value)
+    end
+
+    def audio_url
+        get('audio_url')
+    end
+
+    def audio_url=(value)
+        set('audio_url', value)
+    end
+
+    def tts_lang
+        get('tts_lang')
+    end
+
+    def tts_lang=(value)
+        set('tts_lang', value)
+    end
+
+    def tts_voice
+        get('tts_voice')
+    end
+
+    def tts_voice=(value)
+        set('tts_voice', value)
+    end
+
+    def service_id
+        get('service_id')
+    end
+
+    def date_variable
+        get('date_variable')
+    end
+
+    def date_variable=(value)
+        set('date_variable', value)
+    end
+
+    def items
+        get('items')
+    end
+
+    def items=(value)
+        set('items', value)
+    end
+
+    def message_type
+        get('message_type')
+    end
+
+    def timezone_id
+        get('timezone_id')
+    end
+
+    def timezone_id=(value)
+        set('timezone_id', value)
+    end
+
+    def time_created
+        get('time_created')
+    end
+
+    def time_updated
+        get('time_updated')
+    end
+
+    def url
+        get('url')
+    end
+
+    def url_edit
+        get('url_edit')
+    end
+
+    def url_send
+        get('url_send')
+    end
+
+    def user_id
+        get('user_id')
+    end
+
+    def project_id
+        get('project_id')
+    end
+
+    def get_base_api_path()
+        "/projects/#{get('project_id')}/campaigns/#{get('id')}"
+    end
+ 
+end
+
+end

data/lib/telerivet/contact.rb

@@ -1,6 +1,17 @@
 module Telerivet
 
 #
+# A contact represents a person or other entity that can be communicated with via phone number
+# or other messaging channel within a project.
+# 
+# Each contact has a name, phone number, and custom variables that can be used
+# to personalize messages. Contacts can belong to one or more groups, and can be used as
+# recipients for broadcasts, campaigns, and other messaging operations.
+# 
+# Contacts can be imported or created individually via the API or web app. If
+# the project's auto_create_contacts setting is enabled, a contact will be automatically
+# created for each unique phone number that a message is sent to or received from.
+# 
 # Fields:
 # 
 #   - id (string, max 34 characters)
@@ -83,6 +94,10 @@ module Telerivet
 #   - project_id
 #       * ID of the project this contact belongs to
 #       * Read-only
+#   
+#   - url
+#       * URL to this contact in the Telerivet web app
+#       * Read-only
 #
 class Contact < Entity
 
@@ -144,7 +159,7 @@ class Contact < 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
@@ -478,6 +493,10 @@ class Contact < Entity
         get('project_id')
     end
 
+    def url
+        get('url')
+    end
+
     def get_base_api_path()
         "/projects/#{get('project_id')}/contacts/#{get('id')}"
     end

data/lib/telerivet/contactservicestate.rb

@@ -40,8 +40,10 @@ module Telerivet
 #       * Read-only
 #   
 #   - vars (Hash)
-#       * 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 _.
+#       * Custom variables stored for this contact/service state. Only persisted when the
+#           state 'id' is non-null; saving with a null 'id' deletes the state and its variables.
+#           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.