rcs 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b62f856fc547382d4d1cf18aa5d06d9746cc02480ed3890318a707c2fba8794
-  data.tar.gz: 9403e66a841948733781b0eddade27c3108cf169e13af030edfe309fea50b530
+  metadata.gz: c98f78cc1ea5796ec8fc65c63be91084717c9b726b8191ad79266ddf73c34285
+  data.tar.gz: 1d4af67f770184e27a8ecfa6ddb67142c62ea935e6e035e6314ded4e7913e554
 SHA512:
-  metadata.gz: 1fcb90da1af1f5cbbc8c429f225199b402f3738455295a21570169cd5a2c77464f57378e90d0bed2f297980d18bcd6c6dac92df7a842f96b8e695c4d05f14592
-  data.tar.gz: 4553c27971714a7fbd92a07002e0e75248463a4dacb30a89a2f9eb570599795bcebba4764f6234c84832b8632b56cf7408ceebebf9cbf4438721a3c1650ac359
+  metadata.gz: 1eeb298dfb7a4207d5e3effb626124e3c27275c2d96f66b48f3013ed67a1dcd6300c47961a71ec0c543ca2166d79d96e7909f2f5d1d425bac3739a16da5365a3
+  data.tar.gz: c856a7edbe4169431bcbe72ede9ddb6e21dea469579b73f60cd1cf3a9ca496e8fa6905b9fc3441bca04e06aeaf0a7c1a16f9e4e9e8addf3fcd7761a0e0be5bb3

data/lib/rcs/messages/rcs/client.rb

@@ -3,6 +3,8 @@
 require_relative "../../../requests"
 require_relative "../../types/rich_message"
 require_relative "types/rcs_send_response"
+require_relative "types/send_typing_indicator_schema_options"
+require_relative "../../types/send_typing_indicator_response"
 require_relative "../../types/rcs_validate_content"
 require_relative "../../types/rcs_validation_result"
 require "async"
@@ -51,6 +53,66 @@ module Pinnacle
         Pinnacle::Messages::Rcs::Types::RcsSendResponse.from_json(json_object: response.body)
       end
 
+      # Send a typing indicator from an RCS agent to a recipient.
+      #  This endpoint allows RCS agents to display a typing indicator to recipients. The
+      #  indicator is a message bubble with animated typing dots like this: <img
+      #  le.app/storage/v1/object/public/pinnacle-public-assets/ios-typing-indicator.png"
+      #  alt="Typing Indicator" style="display: inline; height: 1.5em; vertical-align:
+      #  middle; margin: 0 4px;" />
+      #  **Use Case:** Typing indicators are especially useful for providing feedback to
+      #  users while the agent is thinking or generating a response that may take some
+      #  time, creating a more engaging conversational experience.
+      #  **Expiration:** Typing indicators automatically expire after around 20 seconds
+      #  or when the agent sends a message, whichever comes first.
+      #  **Frequency:** You can send typing indicators as many times as needed, though
+      #  only one will be displayed at a time. Sending multiple typing indicators will
+      #  extend the duration of the current indicator.
+      #  > **Note:** Typing indicators are best-effort hints, not delivery-guaranteed
+      #  state. The platform is allowed to coalesce or drop them, and the client UI
+      #  decides when to show/hide.
+      #
+      # @param agent_id [String] The unique identifier of the RCS agent sending the typing indicator. <br>
+      #  Format: `agent_` followed by alphanumeric characters (e.g., `agent_pinnacle`).
+      # @param to [String] The recipient's phone number in E.164 format. <br>
+      #  Must include country code with a leading plus sign (e.g., `+14155551234`).
+      # @param options [Hash] Configure how your typing indicator is sent.Request of type Pinnacle::Messages::Rcs::Types::SendTypingIndicatorSchemaOptions, as a Hash
+      #   * :test_mode (Boolean)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::SendTypingIndicatorResponse]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.rcs.send_typing(
+      #    agent_id: "agent_pinnacle",
+      #    to: "+14154746461",
+      #    options: { test_mode: false }
+      #  )
+      def send_typing(agent_id:, to:, options: nil, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            agentId: agent_id,
+            to: to,
+            options: options
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/messages/typing"
+        end
+        Pinnacle::Types::SendTypingIndicatorResponse.from_json(json_object: response.body)
+      end
+
       # Validate RCS message content without sending it.
       #
       # @param request [Pinnacle::Types::RcsTextContent, Pinnacle::Types::RcsValidateContentMedia, Pinnacle::Types::RcsCards]
@@ -126,6 +188,68 @@ module Pinnacle
         end
       end
 
+      # Send a typing indicator from an RCS agent to a recipient.
+      #  This endpoint allows RCS agents to display a typing indicator to recipients. The
+      #  indicator is a message bubble with animated typing dots like this: <img
+      #  le.app/storage/v1/object/public/pinnacle-public-assets/ios-typing-indicator.png"
+      #  alt="Typing Indicator" style="display: inline; height: 1.5em; vertical-align:
+      #  middle; margin: 0 4px;" />
+      #  **Use Case:** Typing indicators are especially useful for providing feedback to
+      #  users while the agent is thinking or generating a response that may take some
+      #  time, creating a more engaging conversational experience.
+      #  **Expiration:** Typing indicators automatically expire after around 20 seconds
+      #  or when the agent sends a message, whichever comes first.
+      #  **Frequency:** You can send typing indicators as many times as needed, though
+      #  only one will be displayed at a time. Sending multiple typing indicators will
+      #  extend the duration of the current indicator.
+      #  > **Note:** Typing indicators are best-effort hints, not delivery-guaranteed
+      #  state. The platform is allowed to coalesce or drop them, and the client UI
+      #  decides when to show/hide.
+      #
+      # @param agent_id [String] The unique identifier of the RCS agent sending the typing indicator. <br>
+      #  Format: `agent_` followed by alphanumeric characters (e.g., `agent_pinnacle`).
+      # @param to [String] The recipient's phone number in E.164 format. <br>
+      #  Must include country code with a leading plus sign (e.g., `+14155551234`).
+      # @param options [Hash] Configure how your typing indicator is sent.Request of type Pinnacle::Messages::Rcs::Types::SendTypingIndicatorSchemaOptions, as a Hash
+      #   * :test_mode (Boolean)
+      # @param request_options [Pinnacle::RequestOptions]
+      # @return [Pinnacle::Types::SendTypingIndicatorResponse]
+      # @example
+      #  api = Pinnacle::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Pinnacle::Environment::DEFAULT,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.messages.rcs.send_typing(
+      #    agent_id: "agent_pinnacle",
+      #    to: "+14154746461",
+      #    options: { test_mode: false }
+      #  )
+      def send_typing(agent_id:, to:, options: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              agentId: agent_id,
+              to: to,
+              options: options
+            }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/messages/typing"
+          end
+          Pinnacle::Types::SendTypingIndicatorResponse.from_json(json_object: response.body)
+        end
+      end
+
       # Validate RCS message content without sending it.
       #
       # @param request [Pinnacle::Types::RcsTextContent, Pinnacle::Types::RcsValidateContentMedia, Pinnacle::Types::RcsCards]

data/lib/rcs/messages/rcs/types/send_typing_indicator_schema_options.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Messages
+    module Rcs
+      module Types
+        # Configure how your typing indicator is sent.
+        class SendTypingIndicatorSchemaOptions
+          # @return [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+          #  debugging.
+          attr_reader :test_mode
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param test_mode [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+          #  debugging.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [Pinnacle::Messages::Rcs::Types::SendTypingIndicatorSchemaOptions]
+          def initialize(test_mode: OMIT, additional_properties: nil)
+            @test_mode = test_mode if test_mode != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "test_mode": test_mode }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of SendTypingIndicatorSchemaOptions
+          #
+          # @param json_object [String]
+          # @return [Pinnacle::Messages::Rcs::Types::SendTypingIndicatorSchemaOptions]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            test_mode = parsed_json["test_mode"]
+            new(test_mode: test_mode, additional_properties: struct)
+          end
+
+          # Serialize an instance of SendTypingIndicatorSchemaOptions to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.test_mode&.is_a?(Boolean) != false || raise("Passed value for field obj.test_mode is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rcs/types/options.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require_relative "message_schedule"
+require_relative "tracking"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Configure how your RCS message is sent and tracked.
+    class Options
+      # @return [Pinnacle::Types::MessageSchedule]
+      attr_reader :schedule
+      # @return [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+      #  debugging.
+      attr_reader :test_mode
+      # @return [Pinnacle::Types::Tracking]
+      attr_reader :tracking
+      # @return [Boolean] Media files and card media will be transcoded to a supported RCS format. This
+      #  adds a small delay to sending the message. Ignored for rich text messages.
+      attr_reader :transcode
+      # @return [Boolean] Validate your message for any unsupported files. <br>
+      #  If failed, errors will be thrown and the message will not send.
+      attr_reader :validate
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param schedule [Pinnacle::Types::MessageSchedule]
+      # @param test_mode [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+      #  debugging.
+      # @param tracking [Pinnacle::Types::Tracking]
+      # @param transcode [Boolean] Media files and card media will be transcoded to a supported RCS format. This
+      #  adds a small delay to sending the message. Ignored for rich text messages.
+      # @param validate [Boolean] Validate your message for any unsupported files. <br>
+      #  If failed, errors will be thrown and the message will not send.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::Options]
+      def initialize(schedule: OMIT, test_mode: OMIT, tracking: OMIT, transcode: OMIT, validate: OMIT,
+                     additional_properties: nil)
+        @schedule = schedule if schedule != OMIT
+        @test_mode = test_mode if test_mode != OMIT
+        @tracking = tracking if tracking != OMIT
+        @transcode = transcode if transcode != OMIT
+        @validate = validate if validate != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "schedule": schedule,
+          "test_mode": test_mode,
+          "tracking": tracking,
+          "transcode": transcode,
+          "validate": validate
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of Options
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::Options]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["schedule"].nil?
+          schedule = nil
+        else
+          schedule = parsed_json["schedule"].to_json
+          schedule = Pinnacle::Types::MessageSchedule.from_json(json_object: schedule)
+        end
+        test_mode = parsed_json["test_mode"]
+        tracking = parsed_json["tracking"]
+        transcode = parsed_json["transcode"]
+        validate = parsed_json["validate"]
+        new(
+          schedule: schedule,
+          test_mode: test_mode,
+          tracking: tracking,
+          transcode: transcode,
+          validate: validate,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of Options to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.schedule.nil? || Pinnacle::Types::MessageSchedule.validate_raw(obj: obj.schedule)
+        obj.test_mode&.is_a?(Boolean) != false || raise("Passed value for field obj.test_mode is not the expected type, validation failed.")
+        obj.tracking&.is_a?(Pinnacle::Types::Tracking) != false || raise("Passed value for field obj.tracking is not the expected type, validation failed.")
+        obj.transcode&.is_a?(Boolean) != false || raise("Passed value for field obj.transcode is not the expected type, validation failed.")
+        obj.validate&.is_a?(Boolean) != false || raise("Passed value for field obj.validate is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_button_open_url.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "rcs_button_open_url_webview_mode"
 require "ostruct"
 require "json"
 
@@ -7,12 +8,21 @@ module Pinnacle
   module Types
     # Button that opens a URL when tapped by the recipient.
     class RcsButtonOpenUrl
-      # @return [String] Optional additional data to attach to this button.
-      attr_reader :metadata
+      # @return [Pinnacle::Types::RcsButtonOpenUrlWebviewMode] Controls how the URL is displayed when the button is tapped.
+      #  **Default behavior:** If not specified, the URL opens in the device's default
+      #  browser. If you're sending deeplinks, you should use this mode as it will open
+      #  the deeplink in the native app if it is installed.
+      #  **Available modes in order of size:**
+      #  - `HALF` — Half-screen webview overlay
+      #  - `TALL` — Tall webview overlay
+      #  - `FULL` — Full-screen webview
+      attr_reader :webview_mode
       # @return [String] The URL to open when the button is tapped. Must be a valid HTTP or HTTPS URL.
       attr_reader :payload
       # @return [String] Display text for the button.
       attr_reader :title
+      # @return [String] Optional additional data to attach to this button.
+      attr_reader :metadata
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -21,17 +31,31 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param metadata [String] Optional additional data to attach to this button.
+      # @param webview_mode [Pinnacle::Types::RcsButtonOpenUrlWebviewMode] Controls how the URL is displayed when the button is tapped.
+      #  **Default behavior:** If not specified, the URL opens in the device's default
+      #  browser. If you're sending deeplinks, you should use this mode as it will open
+      #  the deeplink in the native app if it is installed.
+      #  **Available modes in order of size:**
+      #  - `HALF` — Half-screen webview overlay
+      #  - `TALL` — Tall webview overlay
+      #  - `FULL` — Full-screen webview
       # @param payload [String] The URL to open when the button is tapped. Must be a valid HTTP or HTTPS URL.
       # @param title [String] Display text for the button.
+      # @param metadata [String] Optional additional data to attach to this button.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::RcsButtonOpenUrl]
-      def initialize(payload:, title:, metadata: OMIT, additional_properties: nil)
-        @metadata = metadata if metadata != OMIT
+      def initialize(payload:, title:, webview_mode: OMIT, metadata: OMIT, additional_properties: nil)
+        @webview_mode = webview_mode if webview_mode != OMIT
         @payload = payload
         @title = title
+        @metadata = metadata if metadata != OMIT
         @additional_properties = additional_properties
-        @_field_set = { "metadata": metadata, "payload": payload, "title": title }.reject do |_k, v|
+        @_field_set = {
+          "webviewMode": webview_mode,
+          "payload": payload,
+          "title": title,
+          "metadata": metadata
+        }.reject do |_k, v|
           v == OMIT
         end
       end
@@ -43,13 +67,15 @@ module Pinnacle
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        metadata = parsed_json["metadata"]
+        webview_mode = parsed_json["webviewMode"]
         payload = parsed_json["payload"]
         title = parsed_json["title"]
+        metadata = parsed_json["metadata"]
         new(
-          metadata: metadata,
+          webview_mode: webview_mode,
           payload: payload,
           title: title,
+          metadata: metadata,
           additional_properties: struct
         )
       end
@@ -68,9 +94,10 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.metadata&.is_a?(String) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+        obj.webview_mode&.is_a?(Pinnacle::Types::RcsButtonOpenUrlWebviewMode) != false || raise("Passed value for field obj.webview_mode is not the expected type, validation failed.")
         obj.payload.is_a?(String) != false || raise("Passed value for field obj.payload is not the expected type, validation failed.")
         obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+        obj.metadata&.is_a?(String) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/rcs_button_open_url_webview_mode.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Controls how the URL is displayed when the button is tapped.
+    #  **Default behavior:** If not specified, the URL opens in the device's default
+    #  browser. If you're sending deeplinks, you should use this mode as it will open
+    #  the deeplink in the native app if it is installed.
+    #  **Available modes in order of size:**
+    #  - `HALF` — Half-screen webview overlay
+    #  - `TALL` — Tall webview overlay
+    #  - `FULL` — Full-screen webview
+    class RcsButtonOpenUrlWebviewMode
+      HALF = "HALF"
+      TALL = "TALL"
+      FULL = "FULL"
+    end
+  end
+end

data/lib/rcs/types/rcs_button_send_location.rb

@@ -8,12 +8,16 @@ module Pinnacle
   module Types
     # Button that shares a specific location with the recipient when tapped.
     class RcsButtonSendLocation
+      # @return [String] Optional name or label for the location that will be displayed in the map app
+      #  (e.g., "Central Park", "Home Office").
+      #  If not provided, the button title will be used as the location name.
+      attr_reader :name
       # @return [Pinnacle::Types::RcsButtonSendLocationLatLong] Geographic coordinates of the location to share.
       attr_reader :lat_long
-      # @return [String] Optional additional data to attach to this button.
-      attr_reader :metadata
       # @return [String] Display text for the button.
       attr_reader :title
+      # @return [String] Optional additional data to attach to this button.
+      attr_reader :metadata
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -22,17 +26,21 @@ module Pinnacle
 
       OMIT = Object.new
 
+      # @param name [String] Optional name or label for the location that will be displayed in the map app
+      #  (e.g., "Central Park", "Home Office").
+      #  If not provided, the button title will be used as the location name.
       # @param lat_long [Pinnacle::Types::RcsButtonSendLocationLatLong] Geographic coordinates of the location to share.
-      # @param metadata [String] Optional additional data to attach to this button.
       # @param title [String] Display text for the button.
+      # @param metadata [String] Optional additional data to attach to this button.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::RcsButtonSendLocation]
-      def initialize(lat_long:, title:, metadata: OMIT, additional_properties: nil)
+      def initialize(lat_long:, title:, name: OMIT, metadata: OMIT, additional_properties: nil)
+        @name = name if name != OMIT
         @lat_long = lat_long
-        @metadata = metadata if metadata != OMIT
         @title = title
+        @metadata = metadata if metadata != OMIT
         @additional_properties = additional_properties
-        @_field_set = { "latLong": lat_long, "metadata": metadata, "title": title }.reject do |_k, v|
+        @_field_set = { "name": name, "latLong": lat_long, "title": title, "metadata": metadata }.reject do |_k, v|
           v == OMIT
         end
       end
@@ -44,18 +52,20 @@ module Pinnacle
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
+        name = parsed_json["name"]
         if parsed_json["latLong"].nil?
           lat_long = nil
         else
           lat_long = parsed_json["latLong"].to_json
           lat_long = Pinnacle::Types::RcsButtonSendLocationLatLong.from_json(json_object: lat_long)
         end
-        metadata = parsed_json["metadata"]
         title = parsed_json["title"]
+        metadata = parsed_json["metadata"]
         new(
+          name: name,
           lat_long: lat_long,
-          metadata: metadata,
           title: title,
+          metadata: metadata,
           additional_properties: struct
         )
       end
@@ -74,9 +84,10 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
+        obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
         Pinnacle::Types::RcsButtonSendLocationLatLong.validate_raw(obj: obj.lat_long)
-        obj.metadata&.is_a?(String) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
         obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+        obj.metadata&.is_a?(String) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/rich_cards_message.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "rcs_base_options"
+require_relative "send_rcs_card_options"
 require_relative "rcs_cards_cards_item"
 require_relative "rich_button"
 require "ostruct"
@@ -9,10 +9,10 @@ require "json"
 module Pinnacle
   module Types
     class RichCardsMessage
+      # @return [Pinnacle::Types::SendRcsCardOptions]
+      attr_reader :options
       # @return [String] Your RCS agent ID which must be prefixed with 'agent_'.
       attr_reader :from
-      # @return [Pinnacle::Types::RcsBaseOptions] Configure how your RCS message is sent and tracked.
-      attr_reader :options
       # @return [String] Recipient's phone number in E.164 format.
       attr_reader :to
       # @return [Array<Pinnacle::Types::RcsCardsCardsItem>] Collection of cards attached to the message.
@@ -27,23 +27,23 @@ module Pinnacle
 
       OMIT = Object.new
 
+      # @param options [Pinnacle::Types::SendRcsCardOptions]
       # @param from [String] Your RCS agent ID which must be prefixed with 'agent_'.
-      # @param options [Pinnacle::Types::RcsBaseOptions] Configure how your RCS message is sent and tracked.
       # @param to [String] Recipient's phone number in E.164 format.
       # @param cards [Array<Pinnacle::Types::RcsCardsCardsItem>] Collection of cards attached to the message.
       # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::RichCardsMessage]
       def initialize(from:, to:, cards:, quick_replies:, options: OMIT, additional_properties: nil)
-        @from = from
         @options = options if options != OMIT
+        @from = from
         @to = to
         @cards = cards
         @quick_replies = quick_replies
         @additional_properties = additional_properties
         @_field_set = {
-          "from": from,
           "options": options,
+          "from": from,
           "to": to,
           "cards": cards,
           "quickReplies": quick_replies
@@ -59,13 +59,13 @@ module Pinnacle
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        from = parsed_json["from"]
         if parsed_json["options"].nil?
           options = nil
         else
           options = parsed_json["options"].to_json
-          options = Pinnacle::Types::RcsBaseOptions.from_json(json_object: options)
+          options = Pinnacle::Types::SendRcsCardOptions.from_json(json_object: options)
         end
+        from = parsed_json["from"]
         to = parsed_json["to"]
         cards = parsed_json["cards"]&.map do |item|
           item = item.to_json
@@ -76,8 +76,8 @@ module Pinnacle
           Pinnacle::Types::RichButton.from_json(json_object: item)
         end
         new(
-          from: from,
           options: options,
+          from: from,
           to: to,
           cards: cards,
           quick_replies: quick_replies,
@@ -99,8 +99,8 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
+        obj.options.nil? || Pinnacle::Types::SendRcsCardOptions.validate_raw(obj: obj.options)
         obj.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
-        obj.options.nil? || Pinnacle::Types::RcsBaseOptions.validate_raw(obj: obj.options)
         obj.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
         obj.cards.is_a?(Array) != false || raise("Passed value for field obj.cards is not the expected type, validation failed.")
         obj.quick_replies.is_a?(Array) != false || raise("Passed value for field obj.quick_replies is not the expected type, validation failed.")

data/lib/rcs/types/send_rcs_card_options.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require_relative "send_rcs_card_options_standalone_card"
+require_relative "message_schedule"
+require_relative "tracking"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class SendRcsCardOptions
+      # @return [Pinnacle::Types::SendRcsCardOptionsStandaloneCard] Configure standalone card layout options for enhanced visual presentation.
+      #  > **⚠️ Important Restriction**
+      #  >
+      #  > This option is **only valid for single card messages**. Using it with multiple
+      #  cards will cause the request to fail with a validation error.
+      attr_reader :standalone_card
+      # @return [Pinnacle::Types::MessageSchedule]
+      attr_reader :schedule
+      # @return [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+      #  debugging.
+      attr_reader :test_mode
+      # @return [Pinnacle::Types::Tracking]
+      attr_reader :tracking
+      # @return [Boolean] Media files and card media will be transcoded to a supported RCS format. This
+      #  adds a small delay to sending the message. Ignored for rich text messages.
+      attr_reader :transcode
+      # @return [Boolean] Validate your message for any unsupported files. <br>
+      #  If failed, errors will be thrown and the message will not send.
+      attr_reader :validate
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param standalone_card [Pinnacle::Types::SendRcsCardOptionsStandaloneCard] Configure standalone card layout options for enhanced visual presentation.
+      #  > **⚠️ Important Restriction**
+      #  >
+      #  > This option is **only valid for single card messages**. Using it with multiple
+      #  cards will cause the request to fail with a validation error.
+      # @param schedule [Pinnacle::Types::MessageSchedule]
+      # @param test_mode [Boolean] Send via the test agent to whitelisted test devices. Useful for development and
+      #  debugging.
+      # @param tracking [Pinnacle::Types::Tracking]
+      # @param transcode [Boolean] Media files and card media will be transcoded to a supported RCS format. This
+      #  adds a small delay to sending the message. Ignored for rich text messages.
+      # @param validate [Boolean] Validate your message for any unsupported files. <br>
+      #  If failed, errors will be thrown and the message will not send.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SendRcsCardOptions]
+      def initialize(standalone_card: OMIT, schedule: OMIT, test_mode: OMIT, tracking: OMIT, transcode: OMIT,
+                     validate: OMIT, additional_properties: nil)
+        @standalone_card = standalone_card if standalone_card != OMIT
+        @schedule = schedule if schedule != OMIT
+        @test_mode = test_mode if test_mode != OMIT
+        @tracking = tracking if tracking != OMIT
+        @transcode = transcode if transcode != OMIT
+        @validate = validate if validate != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "standalone_card": standalone_card,
+          "schedule": schedule,
+          "test_mode": test_mode,
+          "tracking": tracking,
+          "transcode": transcode,
+          "validate": validate
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of SendRcsCardOptions
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SendRcsCardOptions]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["standalone_card"].nil?
+          standalone_card = nil
+        else
+          standalone_card = parsed_json["standalone_card"].to_json
+          standalone_card = Pinnacle::Types::SendRcsCardOptionsStandaloneCard.from_json(json_object: standalone_card)
+        end
+        if parsed_json["schedule"].nil?
+          schedule = nil
+        else
+          schedule = parsed_json["schedule"].to_json
+          schedule = Pinnacle::Types::MessageSchedule.from_json(json_object: schedule)
+        end
+        test_mode = parsed_json["test_mode"]
+        tracking = parsed_json["tracking"]
+        transcode = parsed_json["transcode"]
+        validate = parsed_json["validate"]
+        new(
+          standalone_card: standalone_card,
+          schedule: schedule,
+          test_mode: test_mode,
+          tracking: tracking,
+          transcode: transcode,
+          validate: validate,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SendRcsCardOptions to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.standalone_card.nil? || Pinnacle::Types::SendRcsCardOptionsStandaloneCard.validate_raw(obj: obj.standalone_card)
+        obj.schedule.nil? || Pinnacle::Types::MessageSchedule.validate_raw(obj: obj.schedule)
+        obj.test_mode&.is_a?(Boolean) != false || raise("Passed value for field obj.test_mode is not the expected type, validation failed.")
+        obj.tracking&.is_a?(Pinnacle::Types::Tracking) != false || raise("Passed value for field obj.tracking is not the expected type, validation failed.")
+        obj.transcode&.is_a?(Boolean) != false || raise("Passed value for field obj.transcode is not the expected type, validation failed.")
+        obj.validate&.is_a?(Boolean) != false || raise("Passed value for field obj.validate is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/send_rcs_card_options_standalone_card.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative "send_rcs_card_options_standalone_card_orientation"
+require_relative "send_rcs_card_options_standalone_card_image_alignment"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Configure standalone card layout options for enhanced visual presentation.
+    #  > **⚠️ Important Restriction**
+    #  >
+    #  > This option is **only valid for single card messages**. Using it with multiple
+    #  cards will cause the request to fail with a validation error.
+    class SendRcsCardOptionsStandaloneCard
+      # @return [Pinnacle::Types::SendRcsCardOptionsStandaloneCardOrientation] The orientation of the standalone card.
+      attr_reader :orientation
+      # @return [Pinnacle::Types::SendRcsCardOptionsStandaloneCardImageAlignment] The alignment of the image in the standalone card. This field is ignored if
+      #  orientation is VERTICAL.
+      attr_reader :image_alignment
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param orientation [Pinnacle::Types::SendRcsCardOptionsStandaloneCardOrientation] The orientation of the standalone card.
+      # @param image_alignment [Pinnacle::Types::SendRcsCardOptionsStandaloneCardImageAlignment] The alignment of the image in the standalone card. This field is ignored if
+      #  orientation is VERTICAL.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SendRcsCardOptionsStandaloneCard]
+      def initialize(orientation: OMIT, image_alignment: OMIT, additional_properties: nil)
+        @orientation = orientation if orientation != OMIT
+        @image_alignment = image_alignment if image_alignment != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "orientation": orientation, "image_alignment": image_alignment }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of SendRcsCardOptionsStandaloneCard
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SendRcsCardOptionsStandaloneCard]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        orientation = parsed_json["orientation"]
+        image_alignment = parsed_json["image_alignment"]
+        new(
+          orientation: orientation,
+          image_alignment: image_alignment,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SendRcsCardOptionsStandaloneCard to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.orientation&.is_a?(Pinnacle::Types::SendRcsCardOptionsStandaloneCardOrientation) != false || raise("Passed value for field obj.orientation is not the expected type, validation failed.")
+        obj.image_alignment&.is_a?(Pinnacle::Types::SendRcsCardOptionsStandaloneCardImageAlignment) != false || raise("Passed value for field obj.image_alignment is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/send_rcs_card_options_standalone_card_image_alignment.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # The alignment of the image in the standalone card. This field is ignored if
+    #  orientation is VERTICAL.
+    class SendRcsCardOptionsStandaloneCardImageAlignment
+      LEFT = "LEFT"
+      RIGHT = "RIGHT"
+    end
+  end
+end

data/lib/rcs/types/send_rcs_card_options_standalone_card_orientation.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # The orientation of the standalone card.
+    class SendRcsCardOptionsStandaloneCardOrientation
+      HORIZONTAL = "HORIZONTAL"
+      VERTICAL = "VERTICAL"
+    end
+  end
+end

data/lib/rcs/types/send_typing_indicator_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Response schema confirming the typing indicator was sent.
+    class SendTypingIndicatorResponse
+      # @return [Boolean] Indicates whether the typing indicator was successfully sent.
+      attr_reader :success
+      # @return [String] The RCS agent that sent the typing indicator.
+      attr_reader :agent_id
+      # @return [String] The recipient's phone number that received the typing indicator.
+      attr_reader :recipient
+      # @return [DateTime] Timestamp when the typing indicator was started (ISO 8601 format).
+      attr_reader :started_at
+      # @return [DateTime] Timestamp when the typing indicator will automatically expire (ISO 8601 format).
+      #  <br>
+      #  This is typically one minute after `startedAt` unless a message is sent first.
+      attr_reader :ended_at
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param success [Boolean] Indicates whether the typing indicator was successfully sent.
+      # @param agent_id [String] The RCS agent that sent the typing indicator.
+      # @param recipient [String] The recipient's phone number that received the typing indicator.
+      # @param started_at [DateTime] Timestamp when the typing indicator was started (ISO 8601 format).
+      # @param ended_at [DateTime] Timestamp when the typing indicator will automatically expire (ISO 8601 format).
+      #  <br>
+      #  This is typically one minute after `startedAt` unless a message is sent first.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SendTypingIndicatorResponse]
+      def initialize(success:, agent_id:, recipient:, started_at:, ended_at:, additional_properties: nil)
+        @success = success
+        @agent_id = agent_id
+        @recipient = recipient
+        @started_at = started_at
+        @ended_at = ended_at
+        @additional_properties = additional_properties
+        @_field_set = {
+          "success": success,
+          "agentId": agent_id,
+          "recipient": recipient,
+          "startedAt": started_at,
+          "endedAt": ended_at
+        }
+      end
+
+      # Deserialize a JSON object to an instance of SendTypingIndicatorResponse
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SendTypingIndicatorResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        success = parsed_json["success"]
+        agent_id = parsed_json["agentId"]
+        recipient = parsed_json["recipient"]
+        started_at = (DateTime.parse(parsed_json["startedAt"]) unless parsed_json["startedAt"].nil?)
+        ended_at = (DateTime.parse(parsed_json["endedAt"]) unless parsed_json["endedAt"].nil?)
+        new(
+          success: success,
+          agent_id: agent_id,
+          recipient: recipient,
+          started_at: started_at,
+          ended_at: ended_at,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SendTypingIndicatorResponse to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.success.is_a?(Boolean) != false || raise("Passed value for field obj.success is not the expected type, validation failed.")
+        obj.agent_id.is_a?(String) != false || raise("Passed value for field obj.agent_id is not the expected type, validation failed.")
+        obj.recipient.is_a?(String) != false || raise("Passed value for field obj.recipient is not the expected type, validation failed.")
+        obj.started_at.is_a?(DateTime) != false || raise("Passed value for field obj.started_at is not the expected type, validation failed.")
+        obj.ended_at.is_a?(DateTime) != false || raise("Passed value for field obj.ended_at is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/requests.rb

@@ -43,7 +43,7 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.0" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.1" }
       headers["PINNACLE-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end
@@ -87,7 +87,7 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.0" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.1" }
       headers["PINNACLE-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end

data/lib/types_export.rb

@@ -44,6 +44,7 @@ require_relative "rcs/types/sent_mms_details"
 require_relative "rcs/messages/mms/types/mms_send_response"
 require_relative "rcs/types/sent_rcs_details"
 require_relative "rcs/messages/rcs/types/rcs_send_response"
+require_relative "rcs/messages/rcs/types/send_typing_indicator_schema_options"
 require_relative "rcs/tools/file/types/download_options"
 require_relative "rcs/tools/file/types/upload_file_options"
 require_relative "rcs/tools/contact_card/types/get_v_card_schema_options"
@@ -136,6 +137,7 @@ require_relative "rcs/types/conversation_list"
 require_relative "rcs/types/successful_conversation_update"
 require_relative "rcs/types/sms_content"
 require_relative "rcs/types/mms_content"
+require_relative "rcs/types/rcs_button_open_url_webview_mode"
 require_relative "rcs/types/rcs_button_open_url"
 require_relative "rcs/types/rcs_button_call"
 require_relative "rcs/types/rcs_button_trigger"
@@ -177,8 +179,14 @@ require_relative "rcs/types/rich_text_message"
 require_relative "rcs/types/rich_media_message"
 require_relative "rcs/types/rcs_cards_cards_item"
 require_relative "rcs/types/rcs_cards"
+require_relative "rcs/types/options"
+require_relative "rcs/types/send_rcs_card_options_standalone_card_orientation"
+require_relative "rcs/types/send_rcs_card_options_standalone_card_image_alignment"
+require_relative "rcs/types/send_rcs_card_options_standalone_card"
+require_relative "rcs/types/send_rcs_card_options"
 require_relative "rcs/types/rich_cards_message"
 require_relative "rcs/types/rich_message"
+require_relative "rcs/types/send_typing_indicator_response"
 require_relative "rcs/types/sms_validation_response_segments_gsm_7"
 require_relative "rcs/types/sms_validation_response_segments_utf_16"
 require_relative "rcs/types/sms_validation_response_segments"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcs
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - ''
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-10 00:00:00.000000000 Z
+date: 2025-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -137,6 +137,7 @@ files:
 - lib/rcs/messages/mms/types/send_mms_options.rb
 - lib/rcs/messages/rcs/client.rb
 - lib/rcs/messages/rcs/types/rcs_send_response.rb
+- lib/rcs/messages/rcs/types/send_typing_indicator_schema_options.rb
 - lib/rcs/messages/sms/client.rb
 - lib/rcs/messages/sms/types/send_sms_options.rb
 - lib/rcs/messages/sms/types/sms_send_response.rb
@@ -273,6 +274,7 @@ files:
 - lib/rcs/types/optional_brand_info.rb
 - lib/rcs/types/optional_contact.rb
 - lib/rcs/types/optional_contacts.rb
+- lib/rcs/types/options.rb
 - lib/rcs/types/phone.rb
 - lib/rcs/types/phone_capabilities.rb
 - lib/rcs/types/phone_enum.rb
@@ -297,6 +299,7 @@ files:
 - lib/rcs/types/rcs_base_options.rb
 - lib/rcs/types/rcs_button_call.rb
 - lib/rcs/types/rcs_button_open_url.rb
+- lib/rcs/types/rcs_button_open_url_webview_mode.rb
 - lib/rcs/types/rcs_button_request_user_location.rb
 - lib/rcs/types/rcs_button_schedule_event.rb
 - lib/rcs/types/rcs_button_send_location.rb
@@ -348,8 +351,13 @@ files:
 - lib/rcs/types/rich_text_message.rb
 - lib/rcs/types/scheduled_messaage.rb
 - lib/rcs/types/scheduled_send_response_config.rb
+- lib/rcs/types/send_rcs_card_options.rb
+- lib/rcs/types/send_rcs_card_options_standalone_card.rb
+- lib/rcs/types/send_rcs_card_options_standalone_card_image_alignment.rb
+- lib/rcs/types/send_rcs_card_options_standalone_card_orientation.rb
 - lib/rcs/types/send_sms_response_segments.rb
 - lib/rcs/types/send_sms_response_segments_encoding.rb
+- lib/rcs/types/send_typing_indicator_response.rb
 - lib/rcs/types/sent_mms_details.rb
 - lib/rcs/types/sent_rcs_details.rb
 - lib/rcs/types/sent_sms_details.rb