rcs 1.0.18 → 2.0.0.pre.rc.1

data/lib/rcs/types/sms_validation_response_segments.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "sms_validation_response_segments_gsm_7"
+require_relative "sms_validation_response_segments_utf_16"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Details about how the SMS content would be segmented for delivery.
+    class SmsValidationResponseSegments
+      # @return [Pinnacle::Types::SmsValidationResponseSegmentsGsm7] Segmentation details when your message is encoded with GSM-7.
+      attr_reader :gsm_7
+      # @return [Pinnacle::Types::SmsValidationResponseSegmentsUtf16] Segmentation details when your message is encoded with UTF-16.
+      attr_reader :utf_16
+      # @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 gsm_7 [Pinnacle::Types::SmsValidationResponseSegmentsGsm7] Segmentation details when your message is encoded with GSM-7.
+      # @param utf_16 [Pinnacle::Types::SmsValidationResponseSegmentsUtf16] Segmentation details when your message is encoded with UTF-16.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SmsValidationResponseSegments]
+      def initialize(gsm_7:, utf_16:, additional_properties: nil)
+        @gsm_7 = gsm_7
+        @utf_16 = utf_16
+        @additional_properties = additional_properties
+        @_field_set = { "gsm7": gsm_7, "utf16": utf_16 }
+      end
+
+      # Deserialize a JSON object to an instance of SmsValidationResponseSegments
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SmsValidationResponseSegments]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["gsm7"].nil?
+          gsm_7 = nil
+        else
+          gsm_7 = parsed_json["gsm7"].to_json
+          gsm_7 = Pinnacle::Types::SmsValidationResponseSegmentsGsm7.from_json(json_object: gsm_7)
+        end
+        if parsed_json["utf16"].nil?
+          utf_16 = nil
+        else
+          utf_16 = parsed_json["utf16"].to_json
+          utf_16 = Pinnacle::Types::SmsValidationResponseSegmentsUtf16.from_json(json_object: utf_16)
+        end
+        new(
+          gsm_7: gsm_7,
+          utf_16: utf_16,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SmsValidationResponseSegments 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:)
+        Pinnacle::Types::SmsValidationResponseSegmentsGsm7.validate_raw(obj: obj.gsm_7)
+        Pinnacle::Types::SmsValidationResponseSegmentsUtf16.validate_raw(obj: obj.utf_16)
+      end
+    end
+  end
+end

data/lib/rcs/types/sms_validation_response_segments_gsm_7.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Segmentation details when your message is encoded with GSM-7.
+    class SmsValidationResponseSegmentsGsm7
+      # @return [Integer] Total number of bytes used by the GSM-7 segments.
+      attr_reader :total_bytes
+      # @return [Array<String>] Characters not supported by GSM-7 encoding.
+      attr_reader :unsupported
+      # @return [Array<String>] Message broken down into segments using GSM-7 encoding.
+      attr_reader :value
+      # @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 total_bytes [Integer] Total number of bytes used by the GSM-7 segments.
+      # @param unsupported [Array<String>] Characters not supported by GSM-7 encoding.
+      # @param value [Array<String>] Message broken down into segments using GSM-7 encoding.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SmsValidationResponseSegmentsGsm7]
+      def initialize(total_bytes:, unsupported:, value:, additional_properties: nil)
+        @total_bytes = total_bytes
+        @unsupported = unsupported
+        @value = value
+        @additional_properties = additional_properties
+        @_field_set = { "totalBytes": total_bytes, "unsupported": unsupported, "value": value }
+      end
+
+      # Deserialize a JSON object to an instance of SmsValidationResponseSegmentsGsm7
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SmsValidationResponseSegmentsGsm7]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        total_bytes = parsed_json["totalBytes"]
+        unsupported = parsed_json["unsupported"]
+        value = parsed_json["value"]
+        new(
+          total_bytes: total_bytes,
+          unsupported: unsupported,
+          value: value,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SmsValidationResponseSegmentsGsm7 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.total_bytes.is_a?(Integer) != false || raise("Passed value for field obj.total_bytes is not the expected type, validation failed.")
+        obj.unsupported.is_a?(Array) != false || raise("Passed value for field obj.unsupported is not the expected type, validation failed.")
+        obj.value.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/sms_validation_response_segments_utf_16.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Segmentation details when your message is encoded with UTF-16.
+    class SmsValidationResponseSegmentsUtf16
+      # @return [Integer] Total number of bytes used by the UTF-16 segments.
+      attr_reader :total_bytes
+      # @return [Array<String>] Message broken down into segments using UTF-16 encoding.
+      attr_reader :value
+      # @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 total_bytes [Integer] Total number of bytes used by the UTF-16 segments.
+      # @param value [Array<String>] Message broken down into segments using UTF-16 encoding.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SmsValidationResponseSegmentsUtf16]
+      def initialize(total_bytes:, value:, additional_properties: nil)
+        @total_bytes = total_bytes
+        @value = value
+        @additional_properties = additional_properties
+        @_field_set = { "totalBytes": total_bytes, "value": value }
+      end
+
+      # Deserialize a JSON object to an instance of SmsValidationResponseSegmentsUtf16
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SmsValidationResponseSegmentsUtf16]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        total_bytes = parsed_json["totalBytes"]
+        value = parsed_json["value"]
+        new(
+          total_bytes: total_bytes,
+          value: value,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SmsValidationResponseSegmentsUtf16 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.total_bytes.is_a?(Integer) != false || raise("Passed value for field obj.total_bytes is not the expected type, validation failed.")
+        obj.value.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/sms_validation_response_total.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class SmsValidationResponseTotal
+      # @return [Float] Total price of this message. Calculated by multiplying the number of GSM-7
+      #  segments by the unit cost. <br>
+      #  You must remove all unsupported UTF-16 characters before this message can be
+      #  sent as GSM-7.
+      attr_reader :gsm_7
+      # @return [Float] Total price of this message. Calculated by multiplying the number of UTF-16
+      #  segments by the unit cost.
+      attr_reader :utf_16
+      # @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 gsm_7 [Float] Total price of this message. Calculated by multiplying the number of GSM-7
+      #  segments by the unit cost. <br>
+      #  You must remove all unsupported UTF-16 characters before this message can be
+      #  sent as GSM-7.
+      # @param utf_16 [Float] Total price of this message. Calculated by multiplying the number of UTF-16
+      #  segments by the unit cost.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SmsValidationResponseTotal]
+      def initialize(gsm_7:, utf_16:, additional_properties: nil)
+        @gsm_7 = gsm_7
+        @utf_16 = utf_16
+        @additional_properties = additional_properties
+        @_field_set = { "gsm7": gsm_7, "utf16": utf_16 }
+      end
+
+      # Deserialize a JSON object to an instance of SmsValidationResponseTotal
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SmsValidationResponseTotal]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        gsm_7 = parsed_json["gsm7"]
+        utf_16 = parsed_json["utf16"]
+        new(
+          gsm_7: gsm_7,
+          utf_16: utf_16,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SmsValidationResponseTotal 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.gsm_7.is_a?(Float) != false || raise("Passed value for field obj.gsm_7 is not the expected type, validation failed.")
+        obj.utf_16.is_a?(Float) != false || raise("Passed value for field obj.utf_16 is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/sms_validation_result.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative "sms_validation_response_segments"
+require_relative "sms_validation_response_total"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class SmsValidationResult
+      # @return [Boolean] Indicates if the message exceeds the allowed segment limit. <br>
+      #  For SMS, this is limit is 10.
+      attr_reader :is_over_segment_limit
+      # @return [Pinnacle::Types::SmsValidationResponseSegments] Details about how the SMS content would be segmented for delivery.
+      attr_reader :segments
+      # @return [Pinnacle::Types::SmsValidationResponseTotal]
+      attr_reader :total
+      # @return [Float] Cost per message segment.
+      attr_reader :unit
+      # @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 is_over_segment_limit [Boolean] Indicates if the message exceeds the allowed segment limit. <br>
+      #  For SMS, this is limit is 10.
+      # @param segments [Pinnacle::Types::SmsValidationResponseSegments] Details about how the SMS content would be segmented for delivery.
+      # @param total [Pinnacle::Types::SmsValidationResponseTotal]
+      # @param unit [Float] Cost per message segment.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SmsValidationResult]
+      def initialize(segments:, total:, unit:, is_over_segment_limit: OMIT, additional_properties: nil)
+        @is_over_segment_limit = is_over_segment_limit if is_over_segment_limit != OMIT
+        @segments = segments
+        @total = total
+        @unit = unit
+        @additional_properties = additional_properties
+        @_field_set = {
+          "isOverSegmentLimit": is_over_segment_limit,
+          "segments": segments,
+          "total": total,
+          "unit": unit
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of SmsValidationResult
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SmsValidationResult]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        is_over_segment_limit = parsed_json["isOverSegmentLimit"]
+        if parsed_json["segments"].nil?
+          segments = nil
+        else
+          segments = parsed_json["segments"].to_json
+          segments = Pinnacle::Types::SmsValidationResponseSegments.from_json(json_object: segments)
+        end
+        if parsed_json["total"].nil?
+          total = nil
+        else
+          total = parsed_json["total"].to_json
+          total = Pinnacle::Types::SmsValidationResponseTotal.from_json(json_object: total)
+        end
+        unit = parsed_json["unit"]
+        new(
+          is_over_segment_limit: is_over_segment_limit,
+          segments: segments,
+          total: total,
+          unit: unit,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of SmsValidationResult 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.is_over_segment_limit&.is_a?(Boolean) != false || raise("Passed value for field obj.is_over_segment_limit is not the expected type, validation failed.")
+        Pinnacle::Types::SmsValidationResponseSegments.validate_raw(obj: obj.segments)
+        Pinnacle::Types::SmsValidationResponseTotal.validate_raw(obj: obj.total)
+        obj.unit.is_a?(Float) != false || raise("Passed value for field obj.unit is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/sub_use_case_enum.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Additional subcategories for the primary use case.
+    class SubUseCaseEnum
+      ACCOUNT_NOTIFICATION = "ACCOUNT_NOTIFICATION"
+      CUSTOMER_CARE = "CUSTOMER_CARE"
+      DELIVERY_NOTIFICATION = "DELIVERY_NOTIFICATION"
+      FRAUD_ALERT = "FRAUD_ALERT"
+      HIGHER_EDUCATION = "HIGHER_EDUCATION"
+      MARKETING = "MARKETING"
+      POLLING_VOTING = "POLLING_VOTING"
+      PUBLIC_SERVICE_ANNOUNCEMENT = "PUBLIC_SERVICE_ANNOUNCEMENT"
+      SECURITY_ALERT = "SECURITY_ALERT"
+      TWO_FA = "TWO_FA"
+    end
+  end
+end

data/lib/rcs/types/submission_results.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class SubmissionResults
+      # @return [Boolean] Indicates if the submission was successful.
+      attr_reader :success
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param success [Boolean] Indicates if the submission was successful.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SubmissionResults]
+      def initialize(success:, additional_properties: nil)
+        @success = success
+        @additional_properties = additional_properties
+        @_field_set = { "success": success }
+      end
+
+      # Deserialize a JSON object to an instance of SubmissionResults
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SubmissionResults]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        success = parsed_json["success"]
+        new(success: success, additional_properties: struct)
+      end
+
+      # Serialize an instance of SubmissionResults to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.success.is_a?(Boolean) != false || raise("Passed value for field obj.success is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/successful_conversation_update.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Successfully updated conversation.
+    class SuccessfulConversationUpdate
+      # @return [Boolean] Indicates the operation was successful.
+      attr_reader :success
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param success [Boolean] Indicates the operation was successful.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::SuccessfulConversationUpdate]
+      def initialize(success:, additional_properties: nil)
+        @success = success
+        @additional_properties = additional_properties
+        @_field_set = { "success": success }
+      end
+
+      # Deserialize a JSON object to an instance of SuccessfulConversationUpdate
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::SuccessfulConversationUpdate]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        success = parsed_json["success"]
+        new(success: success, additional_properties: struct)
+      end
+
+      # Serialize an instance of SuccessfulConversationUpdate to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.success.is_a?(Boolean) != false || raise("Passed value for field obj.success is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/toll_free_campaign.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative "message_volume_enum"
+require_relative "toll_free_campaign_schema_opt_in"
+require_relative "toll_free_campaign_schema_use_case"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class TollFreeCampaign
+      # @return [Integer] Unique identifier for the campaign.
+      attr_reader :campaign_id
+      # @return [Pinnacle::Types::MessageVolumeEnum]
+      attr_reader :monthly_volume
+      # @return [String] Display name of the campaign.
+      attr_reader :name
+      # @return [Pinnacle::Types::TollFreeCampaignSchemaOptIn] Opt-in keyword settings.
+      attr_reader :opt_in
+      # @return [String] Explain message that would be sent.
+      attr_reader :production_message_content
+      # @return [Pinnacle::Types::TollFreeCampaignSchemaUseCase] Use case classification for the campaign.
+      attr_reader :use_case
+      # @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 campaign_id [Integer] Unique identifier for the campaign.
+      # @param monthly_volume [Pinnacle::Types::MessageVolumeEnum]
+      # @param name [String] Display name of the campaign.
+      # @param opt_in [Pinnacle::Types::TollFreeCampaignSchemaOptIn] Opt-in keyword settings.
+      # @param production_message_content [String] Explain message that would be sent.
+      # @param use_case [Pinnacle::Types::TollFreeCampaignSchemaUseCase] Use case classification for the campaign.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::TollFreeCampaign]
+      def initialize(campaign_id: OMIT, monthly_volume: OMIT, name: OMIT, opt_in: OMIT,
+                     production_message_content: OMIT, use_case: OMIT, additional_properties: nil)
+        @campaign_id = campaign_id if campaign_id != OMIT
+        @monthly_volume = monthly_volume if monthly_volume != OMIT
+        @name = name if name != OMIT
+        @opt_in = opt_in if opt_in != OMIT
+        @production_message_content = production_message_content if production_message_content != OMIT
+        @use_case = use_case if use_case != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "campaignId": campaign_id,
+          "monthlyVolume": monthly_volume,
+          "name": name,
+          "optIn": opt_in,
+          "productionMessageContent": production_message_content,
+          "useCase": use_case
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of TollFreeCampaign
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::TollFreeCampaign]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        campaign_id = parsed_json["campaignId"]
+        monthly_volume = parsed_json["monthlyVolume"]
+        name = parsed_json["name"]
+        if parsed_json["optIn"].nil?
+          opt_in = nil
+        else
+          opt_in = parsed_json["optIn"].to_json
+          opt_in = Pinnacle::Types::TollFreeCampaignSchemaOptIn.from_json(json_object: opt_in)
+        end
+        production_message_content = parsed_json["productionMessageContent"]
+        if parsed_json["useCase"].nil?
+          use_case = nil
+        else
+          use_case = parsed_json["useCase"].to_json
+          use_case = Pinnacle::Types::TollFreeCampaignSchemaUseCase.from_json(json_object: use_case)
+        end
+        new(
+          campaign_id: campaign_id,
+          monthly_volume: monthly_volume,
+          name: name,
+          opt_in: opt_in,
+          production_message_content: production_message_content,
+          use_case: use_case,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of TollFreeCampaign 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.campaign_id&.is_a?(Integer) != 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::TollFreeCampaignSchemaOptIn.validate_raw(obj: obj.opt_in)
+        obj.production_message_content&.is_a?(String) != false || raise("Passed value for field obj.production_message_content is not the expected type, validation failed.")
+        obj.use_case.nil? || Pinnacle::Types::TollFreeCampaignSchemaUseCase.validate_raw(obj: obj.use_case)
+      end
+    end
+  end
+end