rcs 2.0.0.pre.rc.5 → 2.0.1

data/lib/rcs/types/conversation_list.rb

@@ -1,36 +1,66 @@
 # frozen_string_literal: true
 
+require_relative "conversation"
+require "ostruct"
 require "json"
-require_relative "error_response"
-require_relative "retrieved_conversations"
 
 module Pinnacle
   module Types
     # Response for list conversation.
     class ConversationList
+      # @return [Integer] Total number of conversations matching the filter.
+      attr_reader :count
+      # @return [Array<Pinnacle::Types::Conversation>]
+      attr_reader :conversations
+      # @return [Boolean] Indicates if more conversations are available beyond the current page.
+      attr_reader :has_more
+      # @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 count [Integer] Total number of conversations matching the filter.
+      # @param conversations [Array<Pinnacle::Types::Conversation>]
+      # @param has_more [Boolean] Indicates if more conversations are available beyond the current page.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ConversationList]
+      def initialize(count:, conversations:, has_more:, additional_properties: nil)
+        @count = count
+        @conversations = conversations
+        @has_more = has_more
+        @additional_properties = additional_properties
+        @_field_set = { "count": count, "conversations": conversations, "hasMore": has_more }
+      end
+
       # Deserialize a JSON object to an instance of ConversationList
       #
       # @param json_object [String]
       # @return [Pinnacle::Types::ConversationList]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        begin
-          Pinnacle::Types::ErrorResponse.validate_raw(obj: struct)
-          return Pinnacle::Types::ErrorResponse.from_json(json_object: struct) unless struct.nil?
-
-          return nil
-        rescue StandardError
-          # noop
+        parsed_json = JSON.parse(json_object)
+        count = parsed_json["count"]
+        conversations = parsed_json["conversations"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::Conversation.from_json(json_object: item)
         end
-        begin
-          Pinnacle::Types::RetrievedConversations.validate_raw(obj: struct)
-          return Pinnacle::Types::RetrievedConversations.from_json(json_object: struct) unless struct.nil?
+        has_more = parsed_json["hasMore"]
+        new(
+          count: count,
+          conversations: conversations,
+          has_more: has_more,
+          additional_properties: struct
+        )
+      end
 
-          return nil
-        rescue StandardError
-          # noop
-        end
-        struct
+      # Serialize an instance of ConversationList 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
@@ -40,17 +70,9 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        begin
-          return Pinnacle::Types::ErrorResponse.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return Pinnacle::Types::RetrievedConversations.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        raise("Passed value matched no type within the union, validation failed.")
+        obj.count.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
+        obj.conversations.is_a?(Array) != false || raise("Passed value for field obj.conversations is not the expected type, validation failed.")
+        obj.has_more.is_a?(Boolean) != false || raise("Passed value for field obj.has_more is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/create_url_options.rb

@@ -7,7 +7,8 @@ module Pinnacle
   module Types
     class CreateUrlOptions
       # @return [String] Expiration date in ISO 8601 format for the shortened URL. <br>
-      #  If omitted, then a permalink is generated instead.
+      #  If omitted, then a permalink is generated instead. Short permalinks contain a
+      #  30-digit link id. Short links with an expiration date contain a 8-digit link id.
       attr_reader :expires_at
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -18,7 +19,8 @@ module Pinnacle
       OMIT = Object.new
 
       # @param expires_at [String] Expiration date in ISO 8601 format for the shortened URL. <br>
-      #  If omitted, then a permalink is generated instead.
+      #  If omitted, then a permalink is generated instead. Short permalinks contain a
+      #  30-digit link id. Short links with an expiration date contain a 8-digit link id.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::CreateUrlOptions]
       def initialize(expires_at: OMIT, additional_properties: nil)

data/lib/rcs/types/detached_webhook_info.rb

@@ -8,7 +8,8 @@ module Pinnacle
     class DetachedWebhookInfo
       # @return [String] Confirmation message.
       attr_reader :message
-      # @return [Integer] ID of the detached webhook.
+      # @return [String] Unique identifier of the webhook within the account. This identifier is a string
+      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
       attr_reader :webhook_id
       # @return [String] Phone number the webhook was detached from in E.164 format.
       attr_reader :phone_number
@@ -21,7 +22,8 @@ module Pinnacle
       OMIT = Object.new
 
       # @param message [String] Confirmation message.
-      # @param webhook_id [Integer] ID of the detached webhook.
+      # @param webhook_id [String] Unique identifier of the webhook within the account. This identifier is a string
+      #  that always begins with the prefix `wh_`, for example: `wh_1234567890`.
       # @param phone_number [String] Phone number the webhook was detached from in E.164 format.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::DetachedWebhookInfo]
@@ -66,7 +68,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
-        obj.webhook_id.is_a?(Integer) != false || raise("Passed value for field obj.webhook_id is not the expected type, validation failed.")
+        obj.webhook_id.is_a?(String) != false || raise("Passed value for field obj.webhook_id is not the expected type, validation failed.")
         obj.phone_number.is_a?(String) != false || raise("Passed value for field obj.phone_number is not the expected type, validation failed.")
       end
     end

data/lib/rcs/types/dlc_campaign_status.rb

@@ -13,7 +13,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 DLC campaign.
+      # @return [String] The unique identifier of the 10DLC campaign. This identifier is a string that
+      #  always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       attr_reader :id
       # @return [Pinnacle::Types::ProfileStatusEnum] Current review status of the DLC campaign. <br>
       #  `INCOMPLETE`: Not submitted.<br>
@@ -37,7 +38,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 DLC campaign.
+      # @param id [String] The unique identifier of the 10DLC campaign. This identifier is a string that
+      #  always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       # @param status [Pinnacle::Types::ProfileStatusEnum] Current review status of the DLC campaign. <br>
       #  `INCOMPLETE`: Not submitted.<br>
       #  `IN REVIEW`: Being reviewed by carriers.<br>
@@ -98,7 +100,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.")
         obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         Pinnacle::Types::GetDlcCampaignStatusResponseUpdates.validate_raw(obj: obj.updates)
       end

data/lib/rcs/types/dlc_campaign_with_extended_brand_and_status.rb

@@ -17,7 +17,8 @@ module Pinnacle
       attr_reader :auto_renew
       # @return [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
       attr_reader :brand
-      # @return [Integer] Unique identifier for the campaign.
+      # @return [String] Unique identifier for the campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       attr_reader :campaign_id
       # @return [String] Description of the campaign.
       attr_reader :description
@@ -33,11 +34,11 @@ module Pinnacle
       attr_reader :options
       # @return [Array<String>] Example messages for the campaign.
       attr_reader :sample_messages
-      # @return [Pinnacle::Types::ProfileStatusEnum] 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.<br>
+      # @return [Pinnacle::Types::ProfileStatusEnum] 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.
       attr_reader :status
       # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase] Use case for the campaign.
       attr_reader :use_case
@@ -51,7 +52,8 @@ module Pinnacle
 
       # @param auto_renew [Boolean] Whether the campaign renews automatically.
       # @param brand [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
-      # @param campaign_id [Integer] Unique identifier for the campaign.
+      # @param campaign_id [String] Unique identifier for the campaign. This identifier is a string that always
+      #  begins with the prefix `dlc_`, for example: `dlc_1234567890`.
       # @param description [String] Description of the campaign.
       # @param keywords [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords] Keyword response configuration.
       # @param links [Pinnacle::Types::DlcWithExtendedBrandAndStatusLinks] Legal documentation links.
@@ -59,25 +61,25 @@ module Pinnacle
       # @param name [String] Display name of the campaign.
       # @param options [Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions] Campaign configuration options.
       # @param sample_messages [Array<String>] Example messages for the campaign.
-      # @param status [Pinnacle::Types::ProfileStatusEnum] 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.<br>
+      # @param status [Pinnacle::Types::ProfileStatusEnum] 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.
       # @param use_case [Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase] Use case for the campaign.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
-      def initialize(auto_renew:, brand:, status:, campaign_id: OMIT, description: OMIT, keywords: OMIT, links: OMIT,
-                     message_flow: OMIT, name: OMIT, options: OMIT, sample_messages: OMIT, use_case: OMIT, additional_properties: nil)
+      def initialize(auto_renew:, brand:, keywords:, options:, status:, campaign_id: OMIT, description: OMIT, links: OMIT,
+                     message_flow: OMIT, name: OMIT, sample_messages: OMIT, use_case: OMIT, additional_properties: nil)
         @auto_renew = auto_renew
         @brand = brand
         @campaign_id = campaign_id if campaign_id != OMIT
         @description = description if description != OMIT
-        @keywords = keywords if keywords != OMIT
+        @keywords = keywords
         @links = links if links != OMIT
         @message_flow = message_flow if message_flow != OMIT
         @name = name if name != OMIT
-        @options = options if options != OMIT
+        @options = options
         @sample_messages = sample_messages if sample_messages != OMIT
         @status = status
         @use_case = use_case if use_case != OMIT
@@ -178,13 +180,13 @@ module Pinnacle
       def self.validate_raw(obj:)
         obj.auto_renew.is_a?(Boolean) != false || raise("Passed value for field obj.auto_renew is not the expected type, validation failed.")
         Pinnacle::Types::ExtendedBrand.validate_raw(obj: obj.brand)
-        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.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
-        obj.keywords.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords.validate_raw(obj: obj.keywords)
+        Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords.validate_raw(obj: obj.keywords)
         obj.links.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusLinks.validate_raw(obj: obj.links)
         obj.message_flow&.is_a?(String) != false || raise("Passed value for field obj.message_flow 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.options.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions.validate_raw(obj: obj.options)
+        Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions.validate_raw(obj: obj.options)
         obj.sample_messages&.is_a?(Array) != false || raise("Passed value for field obj.sample_messages is not the expected type, validation failed.")
         obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.use_case.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase.validate_raw(obj: obj.use_case)

data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords_help.rb

@@ -23,9 +23,9 @@ module Pinnacle
       # @param values [Array<String>] Keywords that trigger help response.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsHelp]
-      def initialize(message: OMIT, values: OMIT, additional_properties: nil)
+      def initialize(values:, message: OMIT, additional_properties: nil)
         @message = message if message != OMIT
-        @values = values if values != OMIT
+        @values = values
         @additional_properties = additional_properties
         @_field_set = { "message": message, "values": values }.reject do |_k, v|
           v == OMIT
@@ -65,7 +65,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
-        obj.values&.is_a?(Array) != false || raise("Passed value for field obj.values is not the expected type, validation failed.")
+        obj.values.is_a?(Array) != false || raise("Passed value for field obj.values is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords_opt_in.rb

@@ -23,11 +23,13 @@ module Pinnacle
       # @param values [Array<String>] Keywords that trigger opt-in.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptIn]
-      def initialize(message:, values:, additional_properties: nil)
-        @message = message
+      def initialize(values:, message: OMIT, additional_properties: nil)
+        @message = message if message != OMIT
         @values = values
         @additional_properties = additional_properties
-        @_field_set = { "message": message, "values": values }
+        @_field_set = { "message": message, "values": values }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of
@@ -62,7 +64,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+        obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
         obj.values.is_a?(Array) != false || raise("Passed value for field obj.values is not the expected type, validation failed.")
       end
     end

data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords_opt_out.rb

@@ -23,11 +23,13 @@ module Pinnacle
       # @param values [Array<String>] Keywords that trigger opt-out.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptOut]
-      def initialize(message:, values:, additional_properties: nil)
-        @message = message
+      def initialize(values:, message: OMIT, additional_properties: nil)
+        @message = message if message != OMIT
         @values = values
         @additional_properties = additional_properties
-        @_field_set = { "message": message, "values": values }
+        @_field_set = { "message": message, "values": values }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of
@@ -62,7 +64,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+        obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
         obj.values.is_a?(Array) != false || raise("Passed value for field obj.values is not the expected type, validation failed.")
       end
     end

data/lib/rcs/types/extended_brand.rb

@@ -12,15 +12,21 @@ module Pinnacle
     class ExtendedBrand
       # @return [String] ISO 8601 formatted timestamp of when this brand was added to our system.
       attr_reader :created_at
-      # @return [Integer] The brand's ID.
+      # @return [String] The brand's ID. This identifier is a string that always begins with the prefix
+      #  `b_`, for example: `b_1234567890`.
       attr_reader :id
       # @return [Boolean] Indicates if this brand is archived.
       attr_reader :is_archived
-      # @return [Pinnacle::Types::BrandStatusEnum] 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.
+      # @return [Pinnacle::Types::BrandStatusEnum] Current review status of the brand. <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. <br>
+      #  `VETTED`: Has undergone additional vetting by a third party service post the
+      #  brand being verified. Your brand will be assigned a trust score, with higher
+      #  trust scores having higher message volumes. <br>
+      #  `UNVERIFIED`: Brand details have been updated, and the brand will need to
+      #  undergo re-verification.
       attr_reader :status
       # @return [String] ISO 8601 formatted timestamp of when this brand was last updated.
       attr_reader :updated_at
@@ -53,13 +59,19 @@ module Pinnacle
       OMIT = Object.new
 
       # @param created_at [String] ISO 8601 formatted timestamp of when this brand was added to our system.
-      # @param id [Integer] The brand's ID.
+      # @param id [String] The brand's ID. This identifier is a string that always begins with the prefix
+      #  `b_`, for example: `b_1234567890`.
       # @param is_archived [Boolean] Indicates if this brand is archived.
-      # @param status [Pinnacle::Types::BrandStatusEnum] 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.
+      # @param status [Pinnacle::Types::BrandStatusEnum] Current review status of the brand. <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. <br>
+      #  `VETTED`: Has undergone additional vetting by a third party service post the
+      #  brand being verified. Your brand will be assigned a trust score, with higher
+      #  trust scores having higher message volumes. <br>
+      #  `UNVERIFIED`: Brand details have been updated, and the brand will need to
+      #  undergo re-verification.
       # @param updated_at [String] ISO 8601 formatted timestamp of when this brand was last updated.
       # @param address [String] Primary brand address where this brand is located.
       # @param contact [Pinnacle::Types::OptionalContacts]
@@ -174,7 +186,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.created_at.is_a?(String) != false || raise("Passed value for field obj.created_at 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.is_archived.is_a?(Boolean) != false || raise("Passed value for field obj.is_archived is not the expected type, validation failed.")
         obj.status.is_a?(Pinnacle::Types::BrandStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.updated_at.is_a?(String) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")

data/lib/rcs/types/extended_brand_with_vetting.rb

@@ -20,15 +20,21 @@ module Pinnacle
       attr_reader :vetting_history
       # @return [String] ISO 8601 formatted timestamp of when this brand was added to our system.
       attr_reader :created_at
-      # @return [Integer] The brand's ID.
+      # @return [String] The brand's ID. This identifier is a string that always begins with the prefix
+      #  `b_`, for example: `b_1234567890`.
       attr_reader :id
       # @return [Boolean] Indicates if this brand is archived.
       attr_reader :is_archived
-      # @return [Pinnacle::Types::BrandStatusEnum] 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.
+      # @return [Pinnacle::Types::BrandStatusEnum] Current review status of the brand. <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. <br>
+      #  `VETTED`: Has undergone additional vetting by a third party service post the
+      #  brand being verified. Your brand will be assigned a trust score, with higher
+      #  trust scores having higher message volumes. <br>
+      #  `UNVERIFIED`: Brand details have been updated, and the brand will need to
+      #  undergo re-verification.
       attr_reader :status
       # @return [String] ISO 8601 formatted timestamp of when this brand was last updated.
       attr_reader :updated_at
@@ -64,13 +70,19 @@ module Pinnacle
       # @param tcr_feedback [Array<Pinnacle::Types::VettingFeedback>] Feedback from The Campaign Registry if TCR vetting was performed.
       # @param vetting_history [Array<Pinnacle::Types::VettingHistory>] History of all external vetting attempts for this brand.
       # @param created_at [String] ISO 8601 formatted timestamp of when this brand was added to our system.
-      # @param id [Integer] The brand's ID.
+      # @param id [String] The brand's ID. This identifier is a string that always begins with the prefix
+      #  `b_`, for example: `b_1234567890`.
       # @param is_archived [Boolean] Indicates if this brand is archived.
-      # @param status [Pinnacle::Types::BrandStatusEnum] 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.
+      # @param status [Pinnacle::Types::BrandStatusEnum] Current review status of the brand. <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. <br>
+      #  `VETTED`: Has undergone additional vetting by a third party service post the
+      #  brand being verified. Your brand will be assigned a trust score, with higher
+      #  trust scores having higher message volumes. <br>
+      #  `UNVERIFIED`: Brand details have been updated, and the brand will need to
+      #  undergo re-verification.
       # @param updated_at [String] ISO 8601 formatted timestamp of when this brand was last updated.
       # @param address [String] Primary brand address where this brand is located.
       # @param contact [Pinnacle::Types::OptionalContacts]
@@ -206,7 +218,7 @@ module Pinnacle
         obj.tcr_feedback&.is_a?(Array) != false || raise("Passed value for field obj.tcr_feedback is not the expected type, validation failed.")
         obj.vetting_history.is_a?(Array) != false || raise("Passed value for field obj.vetting_history is not the expected type, validation failed.")
         obj.created_at.is_a?(String) != false || raise("Passed value for field obj.created_at 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.is_archived.is_a?(Boolean) != false || raise("Passed value for field obj.is_archived is not the expected type, validation failed.")
         obj.status.is_a?(Pinnacle::Types::BrandStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.updated_at.is_a?(String) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")

data/lib/rcs/types/extended_rcs_campaign.rb

@@ -3,6 +3,7 @@
 require_relative "rcs_campaign_schema_extra_agent"
 require_relative "extended_brand"
 require_relative "rcs_campaign_schema_extra_links"
+require_relative "profile_status_enum"
 require_relative "rcs_campaign_schema_extra_opt_in"
 require_relative "rcs_campaign_schema_extra_opt_out"
 require_relative "rcs_campaign_schema_extra_use_case"
@@ -24,12 +25,15 @@ module Pinnacle
       attr_reader :brand_verification_url
       # @return [Boolean] Indicates whether the brand has provided an attestation.
       attr_reader :brand_attestation
-      # @return [Integer] Unique identifier for the campaign.
+      # @return [String] Unique identifier for the campaign. This identifier is a string that always
+      #  begins with the prefix `rcs_`, for example: `rcs_1234567890`.
       attr_reader :campaign_id
       # @return [Array<String>] List of what the agent might say to users.
       attr_reader :expected_agent_responses
       # @return [Pinnacle::Types::RcsCampaignSchemaExtraLinks] Legal documentation links.
       attr_reader :links
+      # @return [Pinnacle::Types::ProfileStatusEnum]
+      attr_reader :status
       # @return [Pinnacle::Types::RcsCampaignSchemaExtraOptIn] Opt-in configuration.
       attr_reader :opt_in
       # @return [Pinnacle::Types::RcsCampaignSchemaExtraOptOut] Opt-out configuration.
@@ -51,27 +55,30 @@ module Pinnacle
       #  incorporation, business license, or other relevant document. You can typically
       #  find this on the Secretary of State website.
       # @param brand_attestation [Boolean] Indicates whether the brand has provided an attestation.
-      # @param campaign_id [Integer] Unique identifier for the campaign.
+      # @param campaign_id [String] Unique identifier for the campaign. This identifier is a string that always
+      #  begins with the prefix `rcs_`, for example: `rcs_1234567890`.
       # @param expected_agent_responses [Array<String>] List of what the agent might say to users.
       # @param links [Pinnacle::Types::RcsCampaignSchemaExtraLinks] Legal documentation links.
+      # @param status [Pinnacle::Types::ProfileStatusEnum]
       # @param opt_in [Pinnacle::Types::RcsCampaignSchemaExtraOptIn] Opt-in configuration.
       # @param opt_out [Pinnacle::Types::RcsCampaignSchemaExtraOptOut] Opt-out configuration.
       # @param use_case [Pinnacle::Types::RcsCampaignSchemaExtraUseCase] Use case classification for the campaign.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::ExtendedRcsCampaign]
-      def initialize(agent:, agent_id:, brand:, brand_attestation:, campaign_id:, links:, opt_in:, opt_out:, use_case:, brand_verification_url: OMIT,
-                     expected_agent_responses: OMIT, additional_properties: nil)
+      def initialize(agent:, agent_id:, brand:, brand_attestation:, status:, brand_verification_url: OMIT, campaign_id: OMIT,
+                     expected_agent_responses: OMIT, links: OMIT, opt_in: OMIT, opt_out: OMIT, use_case: OMIT, additional_properties: nil)
         @agent = agent
         @agent_id = agent_id
         @brand = brand
         @brand_verification_url = brand_verification_url if brand_verification_url != OMIT
         @brand_attestation = brand_attestation
-        @campaign_id = campaign_id
+        @campaign_id = campaign_id if campaign_id != OMIT
         @expected_agent_responses = expected_agent_responses if expected_agent_responses != OMIT
-        @links = links
-        @opt_in = opt_in
-        @opt_out = opt_out
-        @use_case = use_case
+        @links = links if links != OMIT
+        @status = status
+        @opt_in = opt_in if opt_in != OMIT
+        @opt_out = opt_out if opt_out != OMIT
+        @use_case = use_case if use_case != OMIT
         @additional_properties = additional_properties
         @_field_set = {
           "agent": agent,
@@ -82,6 +89,7 @@ module Pinnacle
           "campaignId": campaign_id,
           "expectedAgentResponses": expected_agent_responses,
           "links": links,
+          "status": status,
           "optIn": opt_in,
           "optOut": opt_out,
           "useCase": use_case
@@ -120,6 +128,7 @@ module Pinnacle
           links = parsed_json["links"].to_json
           links = Pinnacle::Types::RcsCampaignSchemaExtraLinks.from_json(json_object: links)
         end
+        status = parsed_json["status"]
         if parsed_json["optIn"].nil?
           opt_in = nil
         else
@@ -147,6 +156,7 @@ module Pinnacle
           campaign_id: campaign_id,
           expected_agent_responses: expected_agent_responses,
           links: links,
+          status: status,
           opt_in: opt_in,
           opt_out: opt_out,
           use_case: use_case,
@@ -173,12 +183,13 @@ module Pinnacle
         Pinnacle::Types::ExtendedBrand.validate_raw(obj: obj.brand)
         obj.brand_verification_url&.is_a?(String) != false || raise("Passed value for field obj.brand_verification_url is not the expected type, validation failed.")
         obj.brand_attestation.is_a?(Boolean) != false || raise("Passed value for field obj.brand_attestation 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.expected_agent_responses&.is_a?(Array) != false || raise("Passed value for field obj.expected_agent_responses is not the expected type, validation failed.")
-        Pinnacle::Types::RcsCampaignSchemaExtraLinks.validate_raw(obj: obj.links)
-        Pinnacle::Types::RcsCampaignSchemaExtraOptIn.validate_raw(obj: obj.opt_in)
-        Pinnacle::Types::RcsCampaignSchemaExtraOptOut.validate_raw(obj: obj.opt_out)
-        Pinnacle::Types::RcsCampaignSchemaExtraUseCase.validate_raw(obj: obj.use_case)
+        obj.links.nil? || Pinnacle::Types::RcsCampaignSchemaExtraLinks.validate_raw(obj: obj.links)
+        obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.opt_in.nil? || Pinnacle::Types::RcsCampaignSchemaExtraOptIn.validate_raw(obj: obj.opt_in)
+        obj.opt_out.nil? || Pinnacle::Types::RcsCampaignSchemaExtraOptOut.validate_raw(obj: obj.opt_out)
+        obj.use_case.nil? || Pinnacle::Types::RcsCampaignSchemaExtraUseCase.validate_raw(obj: obj.use_case)
       end
     end
   end