rcs 2.0.0.pre.rc.4 → 2.0.0.pre.rc.5

data/lib/rcs/types/error_response.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    class ErrorResponse
+      # @return [String] Description of the error that occurred.
+      attr_reader :error
+      # @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 error [String] Description of the error that occurred.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::ErrorResponse]
+      def initialize(error: OMIT, additional_properties: nil)
+        @error = error if error != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "error": error }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of ErrorResponse
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::ErrorResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        error = parsed_json["error"]
+        new(error: error, additional_properties: struct)
+      end
+
+      # Serialize an instance of ErrorResponse 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.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/get_dlc_campaign_status_response_updates.rb

@@ -6,7 +6,7 @@ require "json"
 
 module Pinnacle
   module Types
-    # Status of toll free numbers that are being attached to this campaign. <br>
+    # Status of local long code 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).
     class GetDlcCampaignStatusResponseUpdates

data/lib/rcs/types/message_schedule.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "date"
 require "ostruct"
 require "json"
 
@@ -8,7 +7,7 @@ module Pinnacle
   module Types
     # Define when and how your message should be sent.
     class MessageSchedule
-      # @return [DateTime] Date and time when you want recurring messages to stop in ISO 8601 format.
+      # @return [String] Date and time when you want recurring messages to stop in ISO 8601 format.
       attr_reader :end_date
       # @return [String] Provide an AWS cron expression to control the when messages are sent. <br>
       #  [Learn more about cron
@@ -26,7 +25,7 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param end_date [DateTime] Date and time when you want recurring messages to stop in ISO 8601 format.
+      # @param end_date [String] Date and time when you want recurring messages to stop in ISO 8601 format.
       # @param recurrence [String] Provide an AWS cron expression to control the when messages are sent. <br>
       #  [Learn more about cron
       #  ocs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html).
@@ -57,7 +56,7 @@ module Pinnacle
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        end_date = (DateTime.parse(parsed_json["endDate"]) unless parsed_json["endDate"].nil?)
+        end_date = parsed_json["endDate"]
         recurrence = parsed_json["recurrence"]
         send_at = parsed_json["sendAt"]
         timezone = parsed_json["timezone"]
@@ -84,7 +83,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.end_date&.is_a?(DateTime) != false || raise("Passed value for field obj.end_date is not the expected type, validation failed.")
+        obj.end_date&.is_a?(String) != false || raise("Passed value for field obj.end_date is not the expected type, validation failed.")
         obj.recurrence&.is_a?(String) != false || raise("Passed value for field obj.recurrence is not the expected type, validation failed.")
         obj.send_at.is_a?(String) != false || raise("Passed value for field obj.send_at is not the expected type, validation failed.")
         obj.timezone.is_a?(String) != false || raise("Passed value for field obj.timezone is not the expected type, validation failed.")

data/lib/rcs/types/rcs_campaign_schema_agent.rb

@@ -22,9 +22,9 @@ module Pinnacle
       attr_reader :phones
       # @return [Array<Pinnacle::Types::RcsCampaignSchemaAgentWebsitesItem>] List of urls.
       attr_reader :websites
-      # @return [String] Link to the agent's hero.
+      # @return [String] Link to the agent's hero. Hero must be an image file with dimensions 1440x448px.
       attr_reader :hero_url
-      # @return [String] Link to the agent's icon.
+      # @return [String] Link to the agent's icon. Icon must be an image file with dimensions 224x224px.
       attr_reader :icon_url
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -40,8 +40,8 @@ module Pinnacle
       # @param emails [Array<Pinnacle::Types::RcsCampaignSchemaAgentEmailsItem>] List of emails.
       # @param phones [Array<Pinnacle::Types::RcsCampaignSchemaAgentPhonesItem>] List of phone numbers.
       # @param websites [Array<Pinnacle::Types::RcsCampaignSchemaAgentWebsitesItem>] List of urls.
-      # @param hero_url [String] Link to the agent's hero.
-      # @param icon_url [String] Link to the agent's icon.
+      # @param hero_url [String] Link to the agent's hero. Hero must be an image file with dimensions 1440x448px.
+      # @param icon_url [String] Link to the agent's icon. Icon must be an image file with dimensions 224x224px.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::RcsCampaignSchemaAgent]
       def initialize(name: OMIT, description: OMIT, color: OMIT, emails: OMIT, phones: OMIT, websites: OMIT,

data/lib/rcs/types/rcs_campaign_schema_extra_agent.rb

@@ -16,9 +16,9 @@ module Pinnacle
       attr_reader :description
       # @return [Array<Pinnacle::Types::RcsCampaignSchemaExtraAgentEmailsItem>] List of emails.
       attr_reader :emails
-      # @return [String] Link to the agent's hero.
+      # @return [String] Link to the agent's hero. Hero must be an image file with dimensions 1440x448px.
       attr_reader :hero_url
-      # @return [String] Link to the agent's icon.
+      # @return [String] Link to the agent's icon. Icon must be an image file with dimensions 224x224px.
       attr_reader :icon_url
       # @return [String] Name of the agent.
       attr_reader :name
@@ -37,8 +37,8 @@ module Pinnacle
       # @param color [String] Color of the agent's buttons.
       # @param description [String] Description of the agent.
       # @param emails [Array<Pinnacle::Types::RcsCampaignSchemaExtraAgentEmailsItem>] List of emails.
-      # @param hero_url [String] Link to the agent's hero.
-      # @param icon_url [String] Link to the agent's icon.
+      # @param hero_url [String] Link to the agent's hero. Hero must be an image file with dimensions 1440x448px.
+      # @param icon_url [String] Link to the agent's icon. Icon must be an image file with dimensions 224x224px.
       # @param name [String] Name of the agent.
       # @param phones [Array<Pinnacle::Types::RcsCampaignSchemaExtraAgentPhonesItem>] List of phone numbers.
       # @param websites [Array<Pinnacle::Types::RcsCampaignSchemaExtraAgentWebsitesItem>] List of urls.

data/lib/rcs/types/rcs_capabilities_result.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    RCS_CAPABILITIES_RESULT = Hash
+  end
+end

data/lib/rcs/types/rcs_capability.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "rcs_capability_cards"
+require_relative "rcs_capability_actions"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # RCS capabilities for a phone number
+    class RcsCapability
+      # @return [Pinnacle::Types::RcsCapabilityCards]
+      attr_reader :cards
+      # @return [Pinnacle::Types::RcsCapabilityActions] Supported button action types inside the rich cards or quick replies. Each key
+      #  is a button action type that defines a specific button type in the Pinnacle API.
+      attr_reader :actions
+      # @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 cards [Pinnacle::Types::RcsCapabilityCards]
+      # @param actions [Pinnacle::Types::RcsCapabilityActions] Supported button action types inside the rich cards or quick replies. Each key
+      #  is a button action type that defines a specific button type in the Pinnacle API.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCapability]
+      def initialize(cards:, actions:, additional_properties: nil)
+        @cards = cards
+        @actions = actions
+        @additional_properties = additional_properties
+        @_field_set = { "cards": cards, "actions": actions }
+      end
+
+      # Deserialize a JSON object to an instance of RcsCapability
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCapability]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["cards"].nil?
+          cards = nil
+        else
+          cards = parsed_json["cards"].to_json
+          cards = Pinnacle::Types::RcsCapabilityCards.from_json(json_object: cards)
+        end
+        if parsed_json["actions"].nil?
+          actions = nil
+        else
+          actions = parsed_json["actions"].to_json
+          actions = Pinnacle::Types::RcsCapabilityActions.from_json(json_object: actions)
+        end
+        new(
+          cards: cards,
+          actions: actions,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCapability 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::RcsCapabilityCards.validate_raw(obj: obj.cards)
+        Pinnacle::Types::RcsCapabilityActions.validate_raw(obj: obj.actions)
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_capability_actions.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Supported button action types inside the rich cards or quick replies. Each key
+    #  is a button action type that defines a specific button type in the Pinnacle API.
+    class RcsCapabilityActions
+      # @return [Boolean] Buttons that open URLs are supported
+      attr_reader :open_url
+      # @return [Boolean] Buttons that make phone calls are supported
+      attr_reader :call
+      # @return [Boolean] Buttons that trigger actions are supported
+      attr_reader :trigger
+      # @return [Boolean] Buttons that request user location are supported
+      attr_reader :request_user_location
+      # @return [Boolean] Buttons are supported
+      attr_reader :schedule_event
+      # @return [Boolean] Buttons that send location are supported
+      attr_reader :send_location
+      # @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 open_url [Boolean] Buttons that open URLs are supported
+      # @param call [Boolean] Buttons that make phone calls are supported
+      # @param trigger [Boolean] Buttons that trigger actions are supported
+      # @param request_user_location [Boolean] Buttons that request user location are supported
+      # @param schedule_event [Boolean] Buttons are supported
+      # @param send_location [Boolean] Buttons that send location are supported
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsCapabilityActions]
+      def initialize(open_url:, call:, trigger:, request_user_location:, schedule_event:, send_location:,
+                     additional_properties: nil)
+        @open_url = open_url
+        @call = call
+        @trigger = trigger
+        @request_user_location = request_user_location
+        @schedule_event = schedule_event
+        @send_location = send_location
+        @additional_properties = additional_properties
+        @_field_set = {
+          "openUrl": open_url,
+          "call": call,
+          "trigger": trigger,
+          "requestUserLocation": request_user_location,
+          "scheduleEvent": schedule_event,
+          "sendLocation": send_location
+        }
+      end
+
+      # Deserialize a JSON object to an instance of RcsCapabilityActions
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsCapabilityActions]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        open_url = parsed_json["openUrl"]
+        call = parsed_json["call"]
+        trigger = parsed_json["trigger"]
+        request_user_location = parsed_json["requestUserLocation"]
+        schedule_event = parsed_json["scheduleEvent"]
+        send_location = parsed_json["sendLocation"]
+        new(
+          open_url: open_url,
+          call: call,
+          trigger: trigger,
+          request_user_location: request_user_location,
+          schedule_event: schedule_event,
+          send_location: send_location,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsCapabilityActions 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.open_url.is_a?(Boolean) != false || raise("Passed value for field obj.open_url is not the expected type, validation failed.")
+        obj.call.is_a?(Boolean) != false || raise("Passed value for field obj.call is not the expected type, validation failed.")
+        obj.trigger.is_a?(Boolean) != false || raise("Passed value for field obj.trigger is not the expected type, validation failed.")
+        obj.request_user_location.is_a?(Boolean) != false || raise("Passed value for field obj.request_user_location is not the expected type, validation failed.")
+        obj.schedule_event.is_a?(Boolean) != false || raise("Passed value for field obj.schedule_event is not the expected type, validation failed.")
+        obj.send_location.is_a?(Boolean) != false || raise("Passed value for field obj.send_location is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_capability_cards.rb

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

data/lib/rcs/types/rcs_link_result.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Response containing the generated RCS service id and/or url. You can always
+    #  create a link with the service id that is returned.
+    #  To create a link follow the format:
+    #  sms://{PHONE_NUMBER}?service_id={SERVICE_ID}&body={URL_ENCODED_BODY}
+    class RcsLinkResult
+      # @return [String] The generated RCS link URL. If no phone number is provided, no url will be
+      #  generated.
+      attr_reader :url
+      # @return [String] The service ID used for the link
+      attr_reader :service_id
+      # @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 url [String] The generated RCS link URL. If no phone number is provided, no url will be
+      #  generated.
+      # @param service_id [String] The service ID used for the link
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsLinkResult]
+      def initialize(service_id:, url: OMIT, additional_properties: nil)
+        @url = url if url != OMIT
+        @service_id = service_id
+        @additional_properties = additional_properties
+        @_field_set = { "url": url, "serviceId": service_id }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsLinkResult
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsLinkResult]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        url = parsed_json["url"]
+        service_id = parsed_json["serviceId"]
+        new(
+          url: url,
+          service_id: service_id,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsLinkResult 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.url&.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+        obj.service_id.is_a?(String) != false || raise("Passed value for field obj.service_id is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/rcs_validate_content_media.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "rich_button"
 require "ostruct"
 require "json"
 
@@ -12,6 +13,8 @@ module Pinnacle
     class RcsValidateContentMedia
       # @return [String] Media file URLs to send.
       attr_reader :media
+      # @return [Array<Pinnacle::Types::RichButton>]
+      attr_reader :quick_replies
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -21,12 +24,14 @@ module Pinnacle
       OMIT = Object.new
 
       # @param media [String] Media file URLs to send.
+      # @param quick_replies [Array<Pinnacle::Types::RichButton>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Pinnacle::Types::RcsValidateContentMedia]
-      def initialize(media:, additional_properties: nil)
+      def initialize(media:, quick_replies:, additional_properties: nil)
         @media = media
+        @quick_replies = quick_replies
         @additional_properties = additional_properties
-        @_field_set = { "media": media }
+        @_field_set = { "media": media, "quickReplies": quick_replies }
       end
 
       # Deserialize a JSON object to an instance of RcsValidateContentMedia
@@ -37,7 +42,15 @@ module Pinnacle
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
         media = parsed_json["media"]
-        new(media: media, additional_properties: struct)
+        quick_replies = parsed_json["quickReplies"]&.map do |item|
+          item = item.to_json
+          Pinnacle::Types::RichButton.from_json(json_object: item)
+        end
+        new(
+          media: media,
+          quick_replies: quick_replies,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of RcsValidateContentMedia to a JSON object
@@ -55,6 +68,7 @@ module Pinnacle
       # @return [Void]
       def self.validate_raw(obj:)
         obj.media.is_a?(String) != false || raise("Passed value for field obj.media is not the expected type, validation failed.")
+        obj.quick_replies.is_a?(Array) != false || raise("Passed value for field obj.quick_replies is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/rcs_whitelist_response.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Response indicating success of whitelisting operation
+    class RcsWhitelistResponse
+      # @return [Boolean] Whether the whitelisting 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] Whether the whitelisting operation was successful
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::RcsWhitelistResponse]
+      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 RcsWhitelistResponse
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::RcsWhitelistResponse]
+      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 RcsWhitelistResponse 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