rcs 2.0.0.pre.rc.4 → 2.0.0

data/lib/rcs/types/scheduled_messaage.rb

@@ -7,7 +7,8 @@ require "json"
 module Pinnacle
   module Types
     class ScheduledMessaage
-      # @return [Integer] Unique identifier for the scheduled send.
+      # @return [String] Unique identifier for the scheduled send. This identifier is a string that
+      #  always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`.
       attr_reader :schedule_id
       # @return [Pinnacle::Types::ScheduledSendResponseConfig] Configuration for the scheduled message.
       attr_reader :config
@@ -19,7 +20,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param schedule_id [Integer] Unique identifier for the scheduled send.
+      # @param schedule_id [String] Unique identifier for the scheduled send. This identifier is a string that
+      #  always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`.
       # @param config [Pinnacle::Types::ScheduledSendResponseConfig] Configuration for the scheduled message.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::ScheduledMessaage]
@@ -65,7 +67,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.schedule_id.is_a?(Integer) != false || raise("Passed value for field obj.schedule_id is not the expected type, validation failed.")
+        obj.schedule_id.is_a?(String) != false || raise("Passed value for field obj.schedule_id is not the expected type, validation failed.")
         Pinnacle::Types::ScheduledSendResponseConfig.validate_raw(obj: obj.config)
       end
     end

data/lib/rcs/types/sent_mms_details.rb

@@ -6,7 +6,8 @@ require "json"
 module Pinnacle
   module Types
     class SentMmsDetails
-      # @return [Array<Integer>] Array of unique identifiers for the sent MMS messages.
+      # @return [Array<String>] Array of unique identifiers for the sent MMS messages. This identifiers are
+      #  strings that always begin with the prefix `msg_`, for example: `msg_1234567890`.
       attr_reader :message_ids
       # @return [Float] Total number of segments used across the message.
       attr_reader :segments
@@ -26,7 +27,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param message_ids [Array<Integer>] Array of unique identifiers for the sent MMS messages.
+      # @param message_ids [Array<String>] Array of unique identifiers for the sent MMS messages. This identifiers are
+      #  strings that always begin with the prefix `msg_`, for example: `msg_1234567890`.
       # @param segments [Float] Total number of segments used across the message.
       # @param total_cost [Float] Total cost of sending the message.
       # @param sender [String] Sender's phone number in E.164 format.

data/lib/rcs/types/sent_rcs_details.rb

@@ -6,8 +6,9 @@ require "json"
 module Pinnacle
   module Types
     class SentRcsDetails
-      # @return [Float] Unique identifier for the sent MMS messages.
-      attr_reader :message_ids
+      # @return [String] Unique identifier for the sent RCS message. This identifier is a string that
+      #  always begins with the prefix `msg_`, for example: `msg_1234567890`.
+      attr_reader :message_id
       # @return [Integer] Total number of segments used across the message.
       attr_reader :segments
       # @return [Float] Total cost of sending the message.
@@ -26,7 +27,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param message_ids [Float] Unique identifier for the sent MMS messages.
+      # @param message_id [String] Unique identifier for the sent RCS message. This identifier is a string that
+      #  always begins with the prefix `msg_`, for example: `msg_1234567890`.
       # @param segments [Integer] Total number of segments used across the message.
       # @param total_cost [Float] Total cost of sending the message.
       # @param sender [String] Sender's phone number in E.164 format.
@@ -34,9 +36,8 @@ module Pinnacle
       # @param status [String] Current status of the message.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::SentRcsDetails]
-      def initialize(segments:, total_cost:, sender:, recipient:, status:, message_ids: OMIT,
-                     additional_properties: nil)
-        @message_ids = message_ids if message_ids != OMIT
+      def initialize(message_id:, segments:, total_cost:, sender:, recipient:, status:, additional_properties: nil)
+        @message_id = message_id
         @segments = segments
         @total_cost = total_cost
         @sender = sender
@@ -44,15 +45,13 @@ module Pinnacle
         @status = status
         @additional_properties = additional_properties
         @_field_set = {
-          "messageIds": message_ids,
+          "messageId": message_id,
           "segments": segments,
           "totalCost": total_cost,
           "sender": sender,
           "recipient": recipient,
           "status": status
-        }.reject do |_k, v|
-          v == OMIT
-        end
+        }
       end
 
       # Deserialize a JSON object to an instance of SentRcsDetails
@@ -62,14 +61,14 @@ module Pinnacle
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        message_ids = parsed_json["messageIds"]
+        message_id = parsed_json["messageId"]
         segments = parsed_json["segments"]
         total_cost = parsed_json["totalCost"]
         sender = parsed_json["sender"]
         recipient = parsed_json["recipient"]
         status = parsed_json["status"]
         new(
-          message_ids: message_ids,
+          message_id: message_id,
           segments: segments,
           total_cost: total_cost,
           sender: sender,
@@ -93,7 +92,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.message_ids&.is_a?(Float) != false || raise("Passed value for field obj.message_ids is not the expected type, validation failed.")
+        obj.message_id.is_a?(String) != false || raise("Passed value for field obj.message_id is not the expected type, validation failed.")
         obj.segments.is_a?(Integer) != false || raise("Passed value for field obj.segments is not the expected type, validation failed.")
         obj.total_cost.is_a?(Float) != false || raise("Passed value for field obj.total_cost 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.")

data/lib/rcs/types/sent_sms_details.rb

@@ -7,7 +7,8 @@ require "json"
 module Pinnacle
   module Types
     class SentSmsDetails
-      # @return [Integer] Unique identifier for the sent message.
+      # @return [String] Unique identifier for the sent message. This identifier is a string that always
+      #  begins with the prefix `msg_`, for example: `msg_1234567890`.
       attr_reader :message_id
       # @return [Pinnacle::Types::SendSmsResponseSegments] Details about how the message was segmented for sending.
       attr_reader :segments
@@ -27,7 +28,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param message_id [Integer] Unique identifier for the sent message.
+      # @param message_id [String] Unique identifier for the sent message. This identifier is a string that always
+      #  begins with the prefix `msg_`, for example: `msg_1234567890`.
       # @param segments [Pinnacle::Types::SendSmsResponseSegments] Details about how the message was segmented for sending.
       # @param total_cost [Float] Total cost of sending the message.
       # @param sender [String] Sender's phone number in E.164 format.
@@ -96,7 +98,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.message_id.is_a?(Integer) != false || raise("Passed value for field obj.message_id is not the expected type, validation failed.")
+        obj.message_id.is_a?(String) != false || raise("Passed value for field obj.message_id is not the expected type, validation failed.")
         Pinnacle::Types::SendSmsResponseSegments.validate_raw(obj: obj.segments)
         obj.total_cost.is_a?(Float) != false || raise("Passed value for field obj.total_cost 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.")

data/lib/rcs/types/toll_free_campaign.rb

@@ -9,7 +9,7 @@ require "json"
 module Pinnacle
   module Types
     class TollFreeCampaign
-      # @return [Integer] Unique identifier for the campaign.
+      # @return [String] Unique identifier for the campaign. Must begin with the prefix `tf_`.
       attr_reader :campaign_id
       # @return [Pinnacle::Types::MessageVolumeEnum]
       attr_reader :monthly_volume
@@ -29,7 +29,7 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param campaign_id [Integer] Unique identifier for the campaign.
+      # @param campaign_id [String] Unique identifier for the campaign. Must begin with the prefix `tf_`.
       # @param monthly_volume [Pinnacle::Types::MessageVolumeEnum]
       # @param name [String] Display name of the campaign.
       # @param opt_in [Pinnacle::Types::UpsertTollFreeCampaignOptIn] Opt-in keyword settings.
@@ -106,7 +106,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.campaign_id&.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
+        obj.campaign_id&.is_a?(String) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
         obj.monthly_volume&.is_a?(Pinnacle::Types::MessageVolumeEnum) != false || raise("Passed value for field obj.monthly_volume 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.opt_in.nil? || Pinnacle::Types::UpsertTollFreeCampaignOptIn.validate_raw(obj: obj.opt_in)

data/lib/rcs/types/toll_free_campaign_status.rb

@@ -12,7 +12,8 @@ module Pinnacle
       #  These errors may request additional information or point out erroneous and/or
       #  missing fields.
       attr_reader :error
-      # @return [Integer] Id of the toll-free campaign.
+      # @return [String] The unique identifier of the toll-free campaign. This identifier is a string
+      #  that always begins with the prefix `tf_`, for example: `tf_1234567890`.
       attr_reader :id
       # @return [Pinnacle::Types::GetTollFreeCampaignStatusResponseUpdates] Status of phone numbers that are being attached to this campaign. <br>
       #  Note that phone numbers can only be attached to `VERIFIED` campaigns via the
@@ -29,7 +30,8 @@ module Pinnacle
       # @param error [String] Summary of errors related to the verification process. <br>
       #  These errors may request additional information or point out erroneous and/or
       #  missing fields.
-      # @param id [Integer] Id of the toll-free campaign.
+      # @param id [String] The unique identifier of the toll-free campaign. This identifier is a string
+      #  that always begins with the prefix `tf_`, for example: `tf_1234567890`.
       # @param updates [Pinnacle::Types::GetTollFreeCampaignStatusResponseUpdates] Status of phone numbers that are being attached to this campaign. <br>
       #  Note that phone numbers can only be attached to `VERIFIED` campaigns via the
       #  [attach campaign endpoint](../phone-numbers/attach-campaign).
@@ -83,7 +85,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
-        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.")
         Pinnacle::Types::GetTollFreeCampaignStatusResponseUpdates.validate_raw(obj: obj.updates)
       end
     end

data/lib/rcs/types/toll_free_campaign_with_extended_brand_and_status.rb

@@ -17,11 +17,10 @@ module Pinnacle
       #  `INCOMPLETE`: Has not been submitted.<br>
       #  `PENDING`: Currently being reviewed.<br>
       #  `VERIFIED`: Verified and good to go.<br>
-      #  `UNVERIFIED`: No longer verified due to an update in the brand details.<br>
       #  `VETTED`: Brand has been vetted by an external provider and has received vetting
       #  scores.
       attr_reader :status
-      # @return [Integer] Unique identifier for the campaign.
+      # @return [String] Unique identifier for the campaign. Must begin with the prefix `tf_`.
       attr_reader :campaign_id
       # @return [Pinnacle::Types::MessageVolumeEnum]
       attr_reader :monthly_volume
@@ -46,10 +45,9 @@ module Pinnacle
       #  `INCOMPLETE`: Has not been submitted.<br>
       #  `PENDING`: Currently being reviewed.<br>
       #  `VERIFIED`: Verified and good to go.<br>
-      #  `UNVERIFIED`: No longer verified due to an update in the brand details.<br>
       #  `VETTED`: Brand has been vetted by an external provider and has received vetting
       #  scores.
-      # @param campaign_id [Integer] Unique identifier for the campaign.
+      # @param campaign_id [String] Unique identifier for the campaign. Must begin with the prefix `tf_`.
       # @param monthly_volume [Pinnacle::Types::MessageVolumeEnum]
       # @param name [String] Display name of the campaign.
       # @param opt_in [Pinnacle::Types::UpsertTollFreeCampaignOptIn] Opt-in keyword settings.
@@ -143,7 +141,7 @@ module Pinnacle
       def self.validate_raw(obj:)
         Pinnacle::Types::ExtendedBrand.validate_raw(obj: obj.brand)
         obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
-        obj.campaign_id&.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
+        obj.campaign_id&.is_a?(String) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
         obj.monthly_volume&.is_a?(Pinnacle::Types::MessageVolumeEnum) != false || raise("Passed value for field obj.monthly_volume 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.opt_in.nil? || Pinnacle::Types::UpsertTollFreeCampaignOptIn.validate_raw(obj: obj.opt_in)

data/lib/rcs/types/updated_contact_id.rb

@@ -6,7 +6,8 @@ require "json"
 module Pinnacle
   module Types
     class UpdatedContactId
-      # @return [Integer] Unique ID of the updated contact.
+      # @return [String] Unique ID of the updated contact. This identifier is a string that always begins
+      #  with the prefix `co_`, for example: `co_1234567890`.
       attr_reader :id
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -16,7 +17,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param id [Integer] Unique ID of the updated contact.
+      # @param id [String] Unique ID of the updated contact. This identifier is a string that always begins
+      #  with the prefix `co_`, for example: `co_1234567890`.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::UpdatedContactId]
       def initialize(id:, additional_properties: nil)
@@ -50,7 +52,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.")
       end
     end
   end

data/lib/rcs/types/user_event.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "user_event_conversation"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Represents an event triggered by a user such as when they start typing.
+    class UserEvent
+      # @return [String] Type of user event.
+      attr_reader :type
+      # @return [String] Timestamp when the user event started in ISO 8601 format.
+      attr_reader :started_at
+      # @return [Pinnacle::Types::UserEventConversation] Conversation metadata containing the conversation ID, sender, and recipient
+      #  information.
+      attr_reader :conversation
+      # @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 type [String] Type of user event.
+      # @param started_at [String] Timestamp when the user event started in ISO 8601 format.
+      # @param conversation [Pinnacle::Types::UserEventConversation] Conversation metadata containing the conversation ID, sender, and recipient
+      #  information.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::UserEvent]
+      def initialize(type:, started_at:, conversation:, additional_properties: nil)
+        @type = type
+        @started_at = started_at
+        @conversation = conversation
+        @additional_properties = additional_properties
+        @_field_set = { "type": type, "startedAt": started_at, "conversation": conversation }
+      end
+
+      # Deserialize a JSON object to an instance of UserEvent
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::UserEvent]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        type = parsed_json["type"]
+        started_at = parsed_json["startedAt"]
+        if parsed_json["conversation"].nil?
+          conversation = nil
+        else
+          conversation = parsed_json["conversation"].to_json
+          conversation = Pinnacle::Types::UserEventConversation.from_json(json_object: conversation)
+        end
+        new(
+          type: type,
+          started_at: started_at,
+          conversation: conversation,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of UserEvent 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        obj.started_at.is_a?(String) != false || raise("Passed value for field obj.started_at is not the expected type, validation failed.")
+        Pinnacle::Types::UserEventConversation.validate_raw(obj: obj.conversation)
+      end
+    end
+  end
+end

data/lib/rcs/types/user_event_conversation.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Conversation metadata containing the conversation ID, sender, and recipient
+    #  information.
+    class UserEventConversation
+      # @return [Integer] Unique identifier for the conversation. To get more conversation details, use
+      #  the [POST /conversations/get](/api-reference/conversations/get) endpoint.
+      attr_reader :id
+      # @return [String] Phone number of the user who triggered the event.
+      attr_reader :from
+      # @return [String] Agent ID that the user is interacting with.
+      attr_reader :to
+      # @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 id [Integer] Unique identifier for the conversation. To get more conversation details, use
+      #  the [POST /conversations/get](/api-reference/conversations/get) endpoint.
+      # @param from [String] Phone number of the user who triggered the event.
+      # @param to [String] Agent ID that the user is interacting with.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::UserEventConversation]
+      def initialize(id:, from:, to:, additional_properties: nil)
+        @id = id
+        @from = from
+        @to = to
+        @additional_properties = additional_properties
+        @_field_set = { "id": id, "from": from, "to": to }
+      end
+
+      # Deserialize a JSON object to an instance of UserEventConversation
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::UserEventConversation]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        from = parsed_json["from"]
+        to = parsed_json["to"]
+        new(
+          id: id,
+          from: from,
+          to: to,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of UserEventConversation 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.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
+        obj.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/v_card_data.rb

@@ -17,7 +17,8 @@ module Pinnacle
       attr_reader :file
       # @return [String] ISO 8601 timestamp of last vCard update.
       attr_reader :revision
-      # @return [Integer] Unique identifier for the contact.
+      # @return [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       attr_reader :id
       # @return [String] Full display name for the vCard.
       attr_reader :formatted_name
@@ -59,7 +60,8 @@ module Pinnacle
 
       # @param file [Pinnacle::Types::VCardDataFile] File associated to the contact.
       # @param revision [String] ISO 8601 timestamp of last vCard update.
-      # @param id [Integer] Unique identifier for the contact.
+      # @param id [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       # @param formatted_name [String] Full display name for the vCard.
       # @param name [Pinnacle::Types::VCardName] Structured name components.
       # @param nickname [Array<String>] Nicknames or aliases.
@@ -215,7 +217,7 @@ module Pinnacle
       def self.validate_raw(obj:)
         Pinnacle::Types::VCardDataFile.validate_raw(obj: obj.file)
         obj.revision&.is_a?(String) != false || raise("Passed value for field obj.revision is not the expected type, validation failed.")
-        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.formatted_name&.is_a?(String) != false || raise("Passed value for field obj.formatted_name is not the expected type, validation failed.")
         obj.name.nil? || Pinnacle::Types::VCardName.validate_raw(obj: obj.name)
         obj.nickname&.is_a?(Array) != false || raise("Passed value for field obj.nickname is not the expected type, validation failed.")

data/lib/rcs/types/validate_campaign_params.rb

@@ -8,7 +8,13 @@ module Pinnacle
     class ValidateCampaignParams
       # @return [String] Any additional information you want to provide.
       attr_reader :additional_info
-      # @return [Integer] Campaign ID.
+      # @return [String] Unique identifier for the campaign.
+      #  - When validating 10DLC campaigns, it must begin with the prefix `dlc_` (e.g.,
+      #  `dlc_1234567890`)
+      #  - When validating toll-free campaigns, it must begin with the prefix `tf_`
+      #  (e.g., `tf_1234567890`)
+      #  - When validating RCS campaigns, it must begin with the prefix `rcs_` (e.g.,
+      #  `rcs_1234567890`)
       attr_reader :campaign_id
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -19,7 +25,13 @@ module Pinnacle
       OMIT = Object.new
 
       # @param additional_info [String] Any additional information you want to provide.
-      # @param campaign_id [Integer] Campaign ID.
+      # @param campaign_id [String] Unique identifier for the campaign.
+      #  - When validating 10DLC campaigns, it must begin with the prefix `dlc_` (e.g.,
+      #  `dlc_1234567890`)
+      #  - When validating toll-free campaigns, it must begin with the prefix `tf_`
+      #  (e.g., `tf_1234567890`)
+      #  - When validating RCS campaigns, it must begin with the prefix `rcs_` (e.g.,
+      #  `rcs_1234567890`)
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::ValidateCampaignParams]
       def initialize(campaign_id:, additional_info: OMIT, additional_properties: nil)
@@ -62,7 +74,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.additional_info&.is_a?(String) != false || raise("Passed value for field obj.additional_info is not the expected type, validation failed.")
-        obj.campaign_id.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
+        obj.campaign_id.is_a?(String) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/vcard.rb

@@ -12,7 +12,8 @@ require "json"
 module Pinnacle
   module Types
     class Vcard
-      # @return [Integer] Unique identifier for the contact.
+      # @return [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       attr_reader :id
       # @return [String] Full display name for the vCard.
       attr_reader :formatted_name
@@ -52,7 +53,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param id [Integer] Unique identifier for the contact.
+      # @param id [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       # @param formatted_name [String] Full display name for the vCard.
       # @param name [Pinnacle::Types::VCardName] Structured name components.
       # @param nickname [Array<String>] Nicknames or aliases.
@@ -193,7 +195,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.formatted_name&.is_a?(String) != false || raise("Passed value for field obj.formatted_name is not the expected type, validation failed.")
         obj.name.nil? || Pinnacle::Types::VCardName.validate_raw(obj: obj.name)
         obj.nickname&.is_a?(Array) != false || raise("Passed value for field obj.nickname is not the expected type, validation failed.")

data/lib/rcs/types/vcard_content.rb

@@ -14,7 +14,8 @@ module Pinnacle
     class VcardContent
       # @return [String] ISO 8601 timestamp of last vCard update.
       attr_reader :revision
-      # @return [Integer] Unique identifier for the contact.
+      # @return [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       attr_reader :id
       # @return [String] Full display name for the vCard.
       attr_reader :formatted_name
@@ -55,7 +56,8 @@ module Pinnacle
       OMIT = Object.new
 
       # @param revision [String] ISO 8601 timestamp of last vCard update.
-      # @param id [Integer] Unique identifier for the contact.
+      # @param id [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       # @param formatted_name [String] Full display name for the vCard.
       # @param name [Pinnacle::Types::VCardName] Structured name components.
       # @param nickname [Array<String>] Nicknames or aliases.
@@ -201,7 +203,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.revision&.is_a?(String) != false || raise("Passed value for field obj.revision is not the expected type, validation failed.")
-        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.formatted_name&.is_a?(String) != false || raise("Passed value for field obj.formatted_name is not the expected type, validation failed.")
         obj.name.nil? || Pinnacle::Types::VCardName.validate_raw(obj: obj.name)
         obj.nickname&.is_a?(Array) != false || raise("Passed value for field obj.nickname is not the expected type, validation failed.")

data/lib/rcs/types/vcard_resource.rb

@@ -6,7 +6,8 @@ require "json"
 module Pinnacle
   module Types
     class VcardResource
-      # @return [Integer] Contact's id
+      # @return [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       attr_reader :id
       # @return [String] Presigned download url to download vCard data. <br>
       #  This link will expire in one hour.
@@ -19,7 +20,8 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param id [Integer] Contact's id
+      # @param id [String] The unique identifier of the contact. This identifier is a string that always
+      #  begins with the prefix `cc_`, for example: `cc_1234567890`.
       # @param download_url [String] Presigned download url to download vCard data. <br>
       #  This link will expire in one hour.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
@@ -63,7 +65,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.download_url&.is_a?(String) != false || raise("Passed value for field obj.download_url is not the expected type, validation failed.")
       end
     end

data/lib/rcs/types/webhook_event_enum.rb

@@ -5,6 +5,7 @@ module Pinnacle
     # Types of events that can trigger webhook notifications for phone numbers.
     #  Subscribe to specific events to receive real-time updates about your phone
     #  number activity.
+    #  Use `null` to listen to all events.
     class WebhookEventEnum
       MESSAGE_STATUS = "MESSAGE.STATUS"
       MESSAGE_RECEIVED = "MESSAGE.RECEIVED"

data/lib/rcs/types/webhooks.rb

@@ -9,7 +9,8 @@ module Pinnacle
     class Webhooks
       # @return [String] URL where webhook events are delivered.
       attr_reader :endpoint
-      # @return [Integer] Unique identifier for the webhook.
+      # @return [String] The unique identifier of the webhook. This identifier is a string that always
+      #  begins with the prefix `wh_`, for example: `wh_1234567890`.
       attr_reader :id
       # @return [String] Name of the webhook.
       attr_reader :name
@@ -22,7 +23,8 @@ module Pinnacle
       OMIT = Object.new
 
       # @param endpoint [String] URL where webhook events are delivered.
-      # @param id [Integer] Unique identifier for the webhook.
+      # @param id [String] The unique identifier of the webhook. This identifier is a string that always
+      #  begins with the prefix `wh_`, for example: `wh_1234567890`.
       # @param name [String] Name of the webhook.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::Webhooks]
@@ -67,7 +69,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.endpoint.is_a?(String) != false || raise("Passed value for field obj.endpoint is not the expected type, validation failed.")
-        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.")
       end
     end