rcs 2.0.0.pre.rc.5 → 2.0.0

data/lib/rcs/types/message_with_reaction.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require_relative "message_with_reaction_direction"
+require_relative "message_content"
+require_relative "message_method_enum"
+require_relative "message_status_enum"
+require_relative "message_protocol_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Message with additional conversation-specific fields including direction and
+    #  reaction.
+    class MessageWithReaction
+      # @return [Pinnacle::Types::MessageWithReactionDirection] Direction of the message flow.
+      attr_reader :direction
+      # @return [String] Unicode emoji reaction attached to this message. <br>
+      #  Null indicates no reaction has been added.
+      attr_reader :reaction
+      # @return [Pinnacle::Types::MessageContent]
+      attr_reader :content
+      # @return [Float] Total cost charged for sending the message. <br>
+      #  Null means the message incurred no cost or has not been charged yet.
+      attr_reader :cost
+      # @return [String] Timestamp indicating when the message was successfully delivered to the
+      #  recipient. <br>
+      #  Null indicates the message has not yet been delivered.
+      attr_reader :delivered_at
+      # @return [String] Detailed explanation of any errors that occurred while delivering the message.
+      #  <br>
+      #  Null indicates no errors.
+      attr_reader :error
+      # @return [String] Unique identifier of the message. This identifier is a string that always begins
+      #  with the prefix `msg_`, for example: `msg_1234567890`.
+      attr_reader :id
+      # @return [Pinnacle::Types::MessageMethodEnum]
+      attr_reader :method_
+      # @return [Integer] Number of segments the message was split into for delivery.
+      attr_reader :num_segments
+      # @return [String] Phone number that received the message in E.164 format.
+      attr_reader :receiver
+      # @return [String] Phone number or agent that sent the message.
+      attr_reader :sender
+      # @return [String] Timestamp indicating when the message was submitted for delivery. <br>
+      #  Null indicates the message is still in the queue.
+      attr_reader :sent_at
+      # @return [Pinnacle::Types::MessageStatusEnum]
+      attr_reader :status
+      # @return [Pinnacle::Types::MessageProtocolEnum]
+      attr_reader :type
+      # @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 direction [Pinnacle::Types::MessageWithReactionDirection] Direction of the message flow.
+      # @param reaction [String] Unicode emoji reaction attached to this message. <br>
+      #  Null indicates no reaction has been added.
+      # @param content [Pinnacle::Types::MessageContent]
+      # @param cost [Float] Total cost charged for sending the message. <br>
+      #  Null means the message incurred no cost or has not been charged yet.
+      # @param delivered_at [String] Timestamp indicating when the message was successfully delivered to the
+      #  recipient. <br>
+      #  Null indicates the message has not yet been delivered.
+      # @param error [String] Detailed explanation of any errors that occurred while delivering the message.
+      #  <br>
+      #  Null indicates no errors.
+      # @param id [String] Unique identifier of the message. This identifier is a string that always begins
+      #  with the prefix `msg_`, for example: `msg_1234567890`.
+      # @param method_ [Pinnacle::Types::MessageMethodEnum]
+      # @param num_segments [Integer] Number of segments the message was split into for delivery.
+      # @param receiver [String] Phone number that received the message in E.164 format.
+      # @param sender [String] Phone number or agent that sent the message.
+      # @param sent_at [String] Timestamp indicating when the message was submitted for delivery. <br>
+      #  Null indicates the message is still in the queue.
+      # @param status [Pinnacle::Types::MessageStatusEnum]
+      # @param type [Pinnacle::Types::MessageProtocolEnum]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::MessageWithReaction]
+      def initialize(direction:, content:, id:, method_:, num_segments:, receiver:, sender:, status:, type:,
+                     reaction: OMIT, cost: OMIT, delivered_at: OMIT, error: OMIT, sent_at: OMIT, additional_properties: nil)
+        @direction = direction
+        @reaction = reaction if reaction != OMIT
+        @content = content
+        @cost = cost if cost != OMIT
+        @delivered_at = delivered_at if delivered_at != OMIT
+        @error = error if error != OMIT
+        @id = id
+        @method_ = method_
+        @num_segments = num_segments
+        @receiver = receiver
+        @sender = sender
+        @sent_at = sent_at if sent_at != OMIT
+        @status = status
+        @type = type
+        @additional_properties = additional_properties
+        @_field_set = {
+          "direction": direction,
+          "reaction": reaction,
+          "content": content,
+          "cost": cost,
+          "deliveredAt": delivered_at,
+          "error": error,
+          "id": id,
+          "method": method_,
+          "numSegments": num_segments,
+          "receiver": receiver,
+          "sender": sender,
+          "sentAt": sent_at,
+          "status": status,
+          "type": type
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of MessageWithReaction
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::MessageWithReaction]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        direction = parsed_json["direction"]
+        reaction = parsed_json["reaction"]
+        if parsed_json["content"].nil?
+          content = nil
+        else
+          content = parsed_json["content"].to_json
+          content = Pinnacle::Types::MessageContent.from_json(json_object: content)
+        end
+        cost = parsed_json["cost"]
+        delivered_at = parsed_json["deliveredAt"]
+        error = parsed_json["error"]
+        id = parsed_json["id"]
+        method_ = parsed_json["method"]
+        num_segments = parsed_json["numSegments"]
+        receiver = parsed_json["receiver"]
+        sender = parsed_json["sender"]
+        sent_at = parsed_json["sentAt"]
+        status = parsed_json["status"]
+        type = parsed_json["type"]
+        new(
+          direction: direction,
+          reaction: reaction,
+          content: content,
+          cost: cost,
+          delivered_at: delivered_at,
+          error: error,
+          id: id,
+          method_: method_,
+          num_segments: num_segments,
+          receiver: receiver,
+          sender: sender,
+          sent_at: sent_at,
+          status: status,
+          type: type,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of MessageWithReaction 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.direction.is_a?(Pinnacle::Types::MessageWithReactionDirection) != false || raise("Passed value for field obj.direction is not the expected type, validation failed.")
+        obj.reaction&.is_a?(String) != false || raise("Passed value for field obj.reaction is not the expected type, validation failed.")
+        Pinnacle::Types::MessageContent.validate_raw(obj: obj.content)
+        obj.cost&.is_a?(Float) != false || raise("Passed value for field obj.cost is not the expected type, validation failed.")
+        obj.delivered_at&.is_a?(String) != false || raise("Passed value for field obj.delivered_at is not the expected type, validation failed.")
+        obj.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.method_.is_a?(Pinnacle::Types::MessageMethodEnum) != false || raise("Passed value for field obj.method_ is not the expected type, validation failed.")
+        obj.num_segments.is_a?(Integer) != false || raise("Passed value for field obj.num_segments is not the expected type, validation failed.")
+        obj.receiver.is_a?(String) != false || raise("Passed value for field obj.receiver is not the expected type, validation failed.")
+        obj.sender.is_a?(String) != false || raise("Passed value for field obj.sender is not the expected type, validation failed.")
+        obj.sent_at&.is_a?(String) != false || raise("Passed value for field obj.sent_at is not the expected type, validation failed.")
+        obj.status.is_a?(Pinnacle::Types::MessageStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.type.is_a?(Pinnacle::Types::MessageProtocolEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/message_with_reaction_direction.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Direction of the message flow.
+    class MessageWithReactionDirection
+      INBOUND = "INBOUND"
+      OUTBOUND = "OUTBOUND"
+    end
+  end
+end

data/lib/rcs/types/{error_response.rb → not_found_error_body.rb}

@@ -5,8 +5,8 @@ require "json"
 
 module Pinnacle
   module Types
-    class ErrorResponse
-      # @return [String] Description of the error that occurred.
+    class NotFoundErrorBody
+      # @return [String]
       attr_reader :error
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -16,9 +16,9 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param error [String] Description of the error that occurred.
+      # @param error [String]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Types::ErrorResponse]
+      # @return [Pinnacle::Types::NotFoundErrorBody]
       def initialize(error: OMIT, additional_properties: nil)
         @error = error if error != OMIT
         @additional_properties = additional_properties
@@ -27,10 +27,10 @@ module Pinnacle
         end
       end
 
-      # Deserialize a JSON object to an instance of ErrorResponse
+      # Deserialize a JSON object to an instance of NotFoundErrorBody
       #
       # @param json_object [String]
-      # @return [Pinnacle::Types::ErrorResponse]
+      # @return [Pinnacle::Types::NotFoundErrorBody]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
@@ -38,7 +38,7 @@ module Pinnacle
         new(error: error, additional_properties: struct)
       end
 
-      # Serialize an instance of ErrorResponse to a JSON object
+      # Serialize an instance of NotFoundErrorBody to a JSON object
       #
       # @return [String]
       def to_json(*_args)

data/lib/rcs/types/phone_number_campaign_attach_phone_numbers_item_campaign.rb

@@ -8,7 +8,9 @@ module Pinnacle
   module Types
     # Campaign that the phone is now attached to.
     class PhoneNumberCampaignAttachPhoneNumbersItemCampaign
-      # @return [Integer] Id of the campaign.
+      # @return [String] Id of the campaign. For `TOLL_FREE` campaigns, it will begin with the prefix
+      #  `tf_`, for example: `tf_1234567890`. For `10DLC` campaigns, it will begin with
+      #  the prefix `dlc_`, for example: `dlc_1234567890`.
       attr_reader :id
       # @return [String] Campaign's name.
       attr_reader :name
@@ -22,7 +24,9 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param id [Integer] Id of the campaign.
+      # @param id [String] Id of the campaign. For `TOLL_FREE` campaigns, it will begin with the prefix
+      #  `tf_`, for example: `tf_1234567890`. For `10DLC` campaigns, it will begin with
+      #  the prefix `dlc_`, for example: `dlc_1234567890`.
       # @param name [String] Campaign's name.
       # @param type [Pinnacle::Types::MessagingProfileEnum]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
@@ -69,7 +73,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
         obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
         obj.type.is_a?(Pinnacle::Types::MessagingProfileEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       end

data/lib/rcs/types/phone_number_campaign_detach_phone_numbers_item_campaign.rb

@@ -8,7 +8,9 @@ module Pinnacle
   module Types
     # Campaign that the phone is now detached from.
     class PhoneNumberCampaignDetachPhoneNumbersItemCampaign
-      # @return [Integer] Id of the campaign.
+      # @return [String] Id of the campaign. For `TOLL_FREE` campaigns, it will begin with the prefix
+      #  `tf_`, for example: `tf_1234567890`. For `10DLC` campaigns, it will begin with
+      #  the prefix `dlc_`, for example: `dlc_1234567890`.
       attr_reader :id
       # @return [String] Campaign's name.
       attr_reader :name
@@ -22,7 +24,9 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param id [Integer] Id of the campaign.
+      # @param id [String] Id of the campaign. For `TOLL_FREE` campaigns, it will begin with the prefix
+      #  `tf_`, for example: `tf_1234567890`. For `10DLC` campaigns, it will begin with
+      #  the prefix `dlc_`, for example: `dlc_1234567890`.
       # @param name [String] Campaign's name.
       # @param type [Pinnacle::Types::MessagingProfileEnum]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
@@ -69,7 +73,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
         obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
         obj.type.is_a?(Pinnacle::Types::MessagingProfileEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
       end

data/lib/rcs/types/pinnacle_file_upload_metadata.rb

@@ -14,6 +14,12 @@ module Pinnacle
       #  Null indicates that `download.expiresAt` was not provided and the expiration
       #  time is defaulted to one hour after uploading.
       attr_reader :expires_at
+      # @return [String] Deletion date for the file in ISO 8601 format. After this date, the file will be
+      #  automatically deleted from our storage.<br>
+      #  If this field is not provided, the file will not be deleted. You can still
+      #  schedule deletion or delete the file manually in the Storage page in the
+      #  dashboard.
+      attr_reader :delete_at
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -27,17 +33,24 @@ module Pinnacle
       # @param expires_at [String] Expiration date in ISO 8601 format for file download access.<br>
       #  Null indicates that `download.expiresAt` was not provided and the expiration
       #  time is defaulted to one hour after uploading.
+      # @param delete_at [String] Deletion date for the file in ISO 8601 format. After this date, the file will be
+      #  automatically deleted from our storage.<br>
+      #  If this field is not provided, the file will not be deleted. You can still
+      #  schedule deletion or delete the file manually in the Storage page in the
+      #  dashboard.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::PinnacleFileUploadMetadata]
-      def initialize(file_name:, content_type:, expires_at: OMIT, additional_properties: nil)
+      def initialize(file_name:, content_type:, expires_at: OMIT, delete_at: OMIT, additional_properties: nil)
         @file_name = file_name
         @content_type = content_type
         @expires_at = expires_at if expires_at != OMIT
+        @delete_at = delete_at if delete_at != OMIT
         @additional_properties = additional_properties
         @_field_set = {
           "fileName": file_name,
           "contentType": content_type,
-          "expiresAt": expires_at
+          "expiresAt": expires_at,
+          "deleteAt": delete_at
         }.reject do |_k, v|
           v == OMIT
         end
@@ -53,10 +66,12 @@ module Pinnacle
         file_name = parsed_json["fileName"]
         content_type = parsed_json["contentType"]
         expires_at = parsed_json["expiresAt"]
+        delete_at = parsed_json["deleteAt"]
         new(
           file_name: file_name,
           content_type: content_type,
           expires_at: expires_at,
+          delete_at: delete_at,
           additional_properties: struct
         )
       end
@@ -78,6 +93,7 @@ module Pinnacle
         obj.file_name.is_a?(String) != false || raise("Passed value for field obj.file_name is not the expected type, validation failed.")
         obj.content_type.is_a?(String) != false || raise("Passed value for field obj.content_type is not the expected type, validation failed.")
         obj.expires_at&.is_a?(String) != false || raise("Passed value for field obj.expires_at is not the expected type, validation failed.")
+        obj.delete_at&.is_a?(String) != false || raise("Passed value for field obj.delete_at is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/profile_status_enum.rb

@@ -2,10 +2,10 @@
 
 module Pinnacle
   module Types
-    # Current review status of the campaign.
-    #  `INCOMPLETE`: Not submitted.
-    #  `IN REVIEW`: Being reviewed by carriers.
-    #  `VERIFIED`: Approved and ready to send messages.
+    # Current review status of the campaign. <br>
+    #  `INCOMPLETE`: Not submitted. <br>
+    #  `IN REVIEW`: Being reviewed by carriers. <br>
+    #  `VERIFIED`: Approved and ready to send messages.<br>
     #  `FAILED`: Issues and errors related to the campaign's details.
     class ProfileStatusEnum
       INCOMPLETE = "INCOMPLETE"

data/lib/rcs/types/rcs_base_options.rb

@@ -16,6 +16,9 @@ module Pinnacle
       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
@@ -31,20 +34,25 @@ module Pinnacle
       # @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::RcsBaseOptions]
-      def initialize(schedule: OMIT, test_mode: OMIT, tracking: OMIT, validate: OMIT, additional_properties: nil)
+      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
@@ -66,11 +74,13 @@ module Pinnacle
         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
         )
@@ -93,6 +103,7 @@ module Pinnacle
         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

data/lib/rcs/types/rcs_button_call.rb

@@ -7,6 +7,8 @@ module Pinnacle
   module Types
     # Button that initiates a phone call when tapped by the recipient.
     class RcsButtonCall
+      # @return [String] Optional additional data to attach to this button.
+      attr_reader :metadata
       # @return [String] Phone number to call in E.164 format
       attr_reader :payload
       # @return [String] Display text for the button.
@@ -19,15 +21,19 @@ module Pinnacle
 
       OMIT = Object.new
 
+      # @param metadata [String] Optional additional data to attach to this button.
       # @param payload [String] Phone number to call in E.164 format
       # @param title [String] Display text for the button.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::RcsButtonCall]
-      def initialize(payload:, title:, additional_properties: nil)
+      def initialize(payload:, title:, metadata: OMIT, additional_properties: nil)
+        @metadata = metadata if metadata != OMIT
         @payload = payload
         @title = title
         @additional_properties = additional_properties
-        @_field_set = { "payload": payload, "title": title }
+        @_field_set = { "metadata": metadata, "payload": payload, "title": title }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of RcsButtonCall
@@ -37,9 +43,11 @@ 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"]
         payload = parsed_json["payload"]
         title = parsed_json["title"]
         new(
+          metadata: metadata,
           payload: payload,
           title: title,
           additional_properties: struct
@@ -60,6 +68,7 @@ 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.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.")
       end

data/lib/rcs/types/rcs_button_open_url.rb

@@ -7,6 +7,8 @@ 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 [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.
@@ -19,15 +21,19 @@ module Pinnacle
 
       OMIT = Object.new
 
+      # @param metadata [String] Optional additional data to attach to this button.
       # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::RcsButtonOpenUrl]
-      def initialize(payload:, title:, additional_properties: nil)
+      def initialize(payload:, title:, metadata: OMIT, additional_properties: nil)
+        @metadata = metadata if metadata != OMIT
         @payload = payload
         @title = title
         @additional_properties = additional_properties
-        @_field_set = { "payload": payload, "title": title }
+        @_field_set = { "metadata": metadata, "payload": payload, "title": title }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of RcsButtonOpenUrl
@@ -37,9 +43,11 @@ 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"]
         payload = parsed_json["payload"]
         title = parsed_json["title"]
         new(
+          metadata: metadata,
           payload: payload,
           title: title,
           additional_properties: struct
@@ -60,6 +68,7 @@ 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.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.")
       end

data/lib/rcs/types/rcs_button_request_user_location.rb

@@ -7,6 +7,8 @@ module Pinnacle
   module Types
     # Button that prompts the recipient to share their current location.
     class RcsButtonRequestUserLocation
+      # @return [String] Optional additional data to attach to this button.
+      attr_reader :metadata
       # @return [String] Display text for the button.
       attr_reader :title
       # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -17,13 +19,17 @@ module Pinnacle
 
       OMIT = Object.new
 
+      # @param metadata [String] Optional additional data to attach to this button.
       # @param title [String] Display text for the button.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::RcsButtonRequestUserLocation]
-      def initialize(title:, additional_properties: nil)
+      def initialize(title:, metadata: OMIT, additional_properties: nil)
+        @metadata = metadata if metadata != OMIT
         @title = title
         @additional_properties = additional_properties
-        @_field_set = { "title": title }
+        @_field_set = { "metadata": metadata, "title": title }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of RcsButtonRequestUserLocation
@@ -33,8 +39,13 @@ 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"]
         title = parsed_json["title"]
-        new(title: title, additional_properties: struct)
+        new(
+          metadata: metadata,
+          title: title,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of RcsButtonRequestUserLocation to a JSON object
@@ -51,6 +62,7 @@ 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.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
       end
     end

data/lib/rcs/types/rcs_button_schedule_event.rb

@@ -15,6 +15,8 @@ module Pinnacle
       attr_reader :event_start_time
       # @return [String] Title of the event.
       attr_reader :event_title
+      # @return [String] Optional additional data to attach to this button.
+      attr_reader :metadata
       # @return [String] Display text for the button.
       attr_reader :title
       # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -29,15 +31,17 @@ module Pinnacle
       # @param event_end_time [String] End time in ISO 8601 format.
       # @param event_start_time [String] Starting time in ISO 8601 format.
       # @param event_title [String] Title of the event.
+      # @param metadata [String] Optional additional data to attach to this button.
       # @param title [String] Display text for the button.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::RcsButtonScheduleEvent]
-      def initialize(event_end_time:, event_start_time:, event_title:, title:, event_description: OMIT,
+      def initialize(event_end_time:, event_start_time:, event_title:, title:, event_description: OMIT, metadata: OMIT,
                      additional_properties: nil)
         @event_description = event_description if event_description != OMIT
         @event_end_time = event_end_time
         @event_start_time = event_start_time
         @event_title = event_title
+        @metadata = metadata if metadata != OMIT
         @title = title
         @additional_properties = additional_properties
         @_field_set = {
@@ -45,6 +49,7 @@ module Pinnacle
           "eventEndTime": event_end_time,
           "eventStartTime": event_start_time,
           "eventTitle": event_title,
+          "metadata": metadata,
           "title": title
         }.reject do |_k, v|
           v == OMIT
@@ -62,12 +67,14 @@ module Pinnacle
         event_end_time = parsed_json["eventEndTime"]
         event_start_time = parsed_json["eventStartTime"]
         event_title = parsed_json["eventTitle"]
+        metadata = parsed_json["metadata"]
         title = parsed_json["title"]
         new(
           event_description: event_description,
           event_end_time: event_end_time,
           event_start_time: event_start_time,
           event_title: event_title,
+          metadata: metadata,
           title: title,
           additional_properties: struct
         )
@@ -91,6 +98,7 @@ module Pinnacle
         obj.event_end_time.is_a?(String) != false || raise("Passed value for field obj.event_end_time is not the expected type, validation failed.")
         obj.event_start_time.is_a?(String) != false || raise("Passed value for field obj.event_start_time is not the expected type, validation failed.")
         obj.event_title.is_a?(String) != false || raise("Passed value for field obj.event_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.")
         obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
       end
     end