trycourier 2.0.0 → 3.0.0.pre.beta1

data/lib/trycourier/bulk/types/bulk_ingest_error.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Courier
+  class Bulk
+    class BulkIngestError
+      attr_reader :user, :error, :additional_properties
+
+      # @param user [Object]
+      # @param error [Object]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Bulk::BulkIngestError]
+      def initialize(user:, error:, additional_properties: nil)
+        # @type [Object]
+        @user = user
+        # @type [Object]
+        @error = error
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of BulkIngestError
+      #
+      # @param json_object [JSON]
+      # @return [Bulk::BulkIngestError]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        user = struct.user
+        error = struct.error
+        new(user: user, error: error, additional_properties: struct)
+      end
+
+      # Serialize an instance of BulkIngestError to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "user": @user, "error": @error }.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.user.is_a?(Object) != false || raise("Passed value for field obj.user is not the expected type, validation failed.")
+        obj.error.is_a?(Object) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/bulk/types/bulk_ingest_users_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "inbound_bulk_message_user"
+require "json"
+
+module Courier
+  class Bulk
+    class BulkIngestUsersParams
+      attr_reader :users, :additional_properties
+
+      # @param users [Array<Bulk::InboundBulkMessageUser>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Bulk::BulkIngestUsersParams]
+      def initialize(users:, additional_properties: nil)
+        # @type [Array<Bulk::InboundBulkMessageUser>]
+        @users = users
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of BulkIngestUsersParams
+      #
+      # @param json_object [JSON]
+      # @return [Bulk::BulkIngestUsersParams]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        users = parsed_json["users"]&.map do |v|
+          v = v.to_json
+          Bulk::InboundBulkMessageUser.from_json(json_object: v)
+        end
+        new(users: users, additional_properties: struct)
+      end
+
+      # Serialize an instance of BulkIngestUsersParams to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "users": @users }.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.users.is_a?(Array) != false || raise("Passed value for field obj.users is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/bulk/types/bulk_ingest_users_response.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "bulk_ingest_error"
+require "json"
+
+module Courier
+  class Bulk
+    class BulkIngestUsersResponse
+      attr_reader :total, :errors, :additional_properties
+
+      # @param total [Integer]
+      # @param errors [Array<Bulk::BulkIngestError>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Bulk::BulkIngestUsersResponse]
+      def initialize(total:, errors: nil, additional_properties: nil)
+        # @type [Integer]
+        @total = total
+        # @type [Array<Bulk::BulkIngestError>]
+        @errors = errors
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of BulkIngestUsersResponse
+      #
+      # @param json_object [JSON]
+      # @return [Bulk::BulkIngestUsersResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        total = struct.total
+        errors = parsed_json["errors"]&.map do |v|
+          v = v.to_json
+          Bulk::BulkIngestError.from_json(json_object: v)
+        end
+        new(total: total, errors: errors, additional_properties: struct)
+      end
+
+      # Serialize an instance of BulkIngestUsersResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "total": @total, "errors": @errors }.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.is_a?(Integer) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
+        obj.errors&.is_a?(Array) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/bulk/types/bulk_job_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Courier
+  class Bulk
+    class BulkJobStatus
+      CREATED = "CREATED"
+      PROCESSING = "PROCESSING"
+      COMPLETED = "COMPLETED"
+      ERROR = "ERROR"
+    end
+  end
+end

data/lib/trycourier/bulk/types/bulk_job_user_status.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Courier
+  class Bulk
+    class BulkJobUserStatus
+      PENDING = "PENDING"
+      ENQUEUED = "ENQUEUED"
+      ERROR = "ERROR"
+    end
+  end
+end

data/lib/trycourier/bulk/types/bulk_message_user_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative "bulk_job_user_status"
+require_relative "../../commons/types/recipient_preferences"
+require_relative "../../send/types/user_recipient"
+require "json"
+
+module Courier
+  class Bulk
+    class BulkMessageUserResponse
+      attr_reader :status, :message_id, :preferences, :profile, :recipient, :data, :to, :additional_properties
+
+      # @param status [Bulk::BulkJobUserStatus]
+      # @param message_id [String]
+      # @param preferences [Commons::RecipientPreferences]
+      # @param profile [Object]
+      # @param recipient [String]
+      # @param data [Object]
+      # @param to [Send::UserRecipient]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Bulk::BulkMessageUserResponse]
+      def initialize(status:, message_id: nil, preferences: nil, profile: nil, recipient: nil, data: nil, to: nil,
+                     additional_properties: nil)
+        # @type [Bulk::BulkJobUserStatus]
+        @status = status
+        # @type [String]
+        @message_id = message_id
+        # @type [Commons::RecipientPreferences]
+        @preferences = preferences
+        # @type [Object]
+        @profile = profile
+        # @type [String]
+        @recipient = recipient
+        # @type [Object]
+        @data = data
+        # @type [Send::UserRecipient]
+        @to = to
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of BulkMessageUserResponse
+      #
+      # @param json_object [JSON]
+      # @return [Bulk::BulkMessageUserResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        status = struct.status
+        message_id = struct.messageId
+        if parsed_json["preferences"].nil?
+          preferences = nil
+        else
+          preferences = parsed_json["preferences"].to_json
+          preferences = Commons::RecipientPreferences.from_json(json_object: preferences)
+        end
+        profile = struct.profile
+        recipient = struct.recipient
+        data = struct.data
+        if parsed_json["to"].nil?
+          to = nil
+        else
+          to = parsed_json["to"].to_json
+          to = Send::UserRecipient.from_json(json_object: to)
+        end
+        new(status: status, message_id: message_id, preferences: preferences, profile: profile, recipient: recipient,
+            data: data, to: to, additional_properties: struct)
+      end
+
+      # Serialize an instance of BulkMessageUserResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "status": @status,
+          "messageId": @message_id,
+          "preferences": @preferences,
+          "profile": @profile,
+          "recipient": @recipient,
+          "data": @data,
+          "to": @to
+        }.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.status.is_a?(Bulk::BulkJobUserStatus) != false || raise("Passed value for field obj.status 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.preferences.nil? || Commons::RecipientPreferences.validate_raw(obj: obj.preferences)
+        obj.profile&.is_a?(Object) != false || raise("Passed value for field obj.profile is not the expected type, validation failed.")
+        obj.recipient&.is_a?(String) != false || raise("Passed value for field obj.recipient is not the expected type, validation failed.")
+        obj.data&.is_a?(Object) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
+        obj.to.nil? || Send::UserRecipient.validate_raw(obj: obj.to)
+      end
+    end
+  end
+end

data/lib/trycourier/bulk/types/inbound_bulk_content_message.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require_relative "../../send/types/content"
+require_relative "../../send/types/message_data"
+require_relative "../../send/types/message_channels"
+require_relative "../../send/types/message_context"
+require_relative "../../send/types/message_metadata"
+require_relative "../../send/types/message_providers"
+require_relative "../../send/types/routing"
+require_relative "../../send/types/timeout"
+require_relative "../../send/types/delay"
+require_relative "../../send/types/expiry"
+require "json"
+
+module Courier
+  class Bulk
+    # The message property has the following primary top-level properties. They define the destination and content of the message.
+    # Additional advanced configuration fields [are defined below](https://www.courier.com/docs/reference/send/message/#other-message-properties).
+    class InboundBulkContentMessage
+      attr_reader :content, :data, :brand_id, :channels, :context, :metadata, :providers, :routing, :timeout, :delay,
+                  :expiry, :additional_properties
+
+      # @param content [Send::Content] Describes the content of the message in a way that will work for email, push,
+      #   chat, or any channel. Either this or template must be specified.
+      # @param data [Send::MESSAGE_DATA] An arbitrary object that includes any data you want to pass to the message.
+      #   The data will populate the corresponding template or elements variables.
+      # @param brand_id [String]
+      # @param channels [Send::MESSAGE_CHANNELS] "Define run-time configuration for one or more channels. If you don't specify channels, the default configuration for each channel will be used. Valid ChannelId's are: email, sms, push, inbox, direct_message, banner, and webhook."
+      # @param context [Send::MessageContext] Context to load with this recipient. Will override any context set on message.context.
+      # @param metadata [Send::MessageMetadata] Metadata such as utm tracking attached with the notification through this channel.
+      # @param providers [Send::MESSAGE_PROVIDERS] An object whose keys are valid provider identifiers which map to an object.
+      # @param routing [Send::Routing]
+      # @param timeout [Send::Timeout] Time in ms to attempt the channel before failing over to the next available channel.
+      # @param delay [Send::Delay] Defines the time to wait before delivering the message.
+      # @param expiry [Send::Expiry] "Expiry allows you to set an absolute or relative time in which a message expires.
+      #   Note: This is only valid for the Courier Inbox channel as of 12-08-2022."
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Bulk::InboundBulkContentMessage]
+      def initialize(content:, data: nil, brand_id: nil, channels: nil, context: nil, metadata: nil, providers: nil,
+                     routing: nil, timeout: nil, delay: nil, expiry: nil, additional_properties: nil)
+        # @type [Send::Content] Describes the content of the message in a way that will work for email, push,
+        #   chat, or any channel. Either this or template must be specified.
+        @content = content
+        # @type [Send::MESSAGE_DATA] An arbitrary object that includes any data you want to pass to the message.
+        #   The data will populate the corresponding template or elements variables.
+        @data = data
+        # @type [String]
+        @brand_id = brand_id
+        # @type [Send::MESSAGE_CHANNELS] "Define run-time configuration for one or more channels. If you don't specify channels, the default configuration for each channel will be used. Valid ChannelId's are: email, sms, push, inbox, direct_message, banner, and webhook."
+        @channels = channels
+        # @type [Send::MessageContext] Context to load with this recipient. Will override any context set on message.context.
+        @context = context
+        # @type [Send::MessageMetadata] Metadata such as utm tracking attached with the notification through this channel.
+        @metadata = metadata
+        # @type [Send::MESSAGE_PROVIDERS] An object whose keys are valid provider identifiers which map to an object.
+        @providers = providers
+        # @type [Send::Routing]
+        @routing = routing
+        # @type [Send::Timeout] Time in ms to attempt the channel before failing over to the next available channel.
+        @timeout = timeout
+        # @type [Send::Delay] Defines the time to wait before delivering the message.
+        @delay = delay
+        # @type [Send::Expiry] "Expiry allows you to set an absolute or relative time in which a message expires.
+        #   Note: This is only valid for the Courier Inbox channel as of 12-08-2022."
+        @expiry = expiry
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of InboundBulkContentMessage
+      #
+      # @param json_object [JSON]
+      # @return [Bulk::InboundBulkContentMessage]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["content"].nil?
+          content = nil
+        else
+          content = parsed_json["content"].to_json
+          content = Send::Content.from_json(json_object: content)
+        end
+        data = struct.data
+        brand_id = struct.brand_id
+        channels = struct.channels
+        if parsed_json["context"].nil?
+          context = nil
+        else
+          context = parsed_json["context"].to_json
+          context = Send::MessageContext.from_json(json_object: context)
+        end
+        if parsed_json["metadata"].nil?
+          metadata = nil
+        else
+          metadata = parsed_json["metadata"].to_json
+          metadata = Send::MessageMetadata.from_json(json_object: metadata)
+        end
+        providers = struct.providers
+        if parsed_json["routing"].nil?
+          routing = nil
+        else
+          routing = parsed_json["routing"].to_json
+          routing = Send::Routing.from_json(json_object: routing)
+        end
+        if parsed_json["timeout"].nil?
+          timeout = nil
+        else
+          timeout = parsed_json["timeout"].to_json
+          timeout = Send::Timeout.from_json(json_object: timeout)
+        end
+        if parsed_json["delay"].nil?
+          delay = nil
+        else
+          delay = parsed_json["delay"].to_json
+          delay = Send::Delay.from_json(json_object: delay)
+        end
+        if parsed_json["expiry"].nil?
+          expiry = nil
+        else
+          expiry = parsed_json["expiry"].to_json
+          expiry = Send::Expiry.from_json(json_object: expiry)
+        end
+        new(content: content, data: data, brand_id: brand_id, channels: channels, context: context, metadata: metadata,
+            providers: providers, routing: routing, timeout: timeout, delay: delay, expiry: expiry, additional_properties: struct)
+      end
+
+      # Serialize an instance of InboundBulkContentMessage to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "content": @content,
+          "data": @data,
+          "brand_id": @brand_id,
+          "channels": @channels,
+          "context": @context,
+          "metadata": @metadata,
+          "providers": @providers,
+          "routing": @routing,
+          "timeout": @timeout,
+          "delay": @delay,
+          "expiry": @expiry
+        }.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:)
+        Send::Content.validate_raw(obj: obj.content)
+        obj.data&.is_a?(Hash) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
+        obj.brand_id&.is_a?(String) != false || raise("Passed value for field obj.brand_id is not the expected type, validation failed.")
+        obj.channels&.is_a?(Hash) != false || raise("Passed value for field obj.channels is not the expected type, validation failed.")
+        obj.context.nil? || Send::MessageContext.validate_raw(obj: obj.context)
+        obj.metadata.nil? || Send::MessageMetadata.validate_raw(obj: obj.metadata)
+        obj.providers&.is_a?(Hash) != false || raise("Passed value for field obj.providers is not the expected type, validation failed.")
+        obj.routing.nil? || Send::Routing.validate_raw(obj: obj.routing)
+        obj.timeout.nil? || Send::Timeout.validate_raw(obj: obj.timeout)
+        obj.delay.nil? || Send::Delay.validate_raw(obj: obj.delay)
+        obj.expiry.nil? || Send::Expiry.validate_raw(obj: obj.expiry)
+      end
+    end
+  end
+end

data/lib/trycourier/bulk/types/inbound_bulk_message.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "inbound_bulk_message_v_2"
+require "json"
+
+module Courier
+  class Bulk
+    class InboundBulkMessage
+      attr_reader :message, :brand, :data, :event, :locale, :override, :additional_properties
+
+      # @param message [Bulk::InboundBulkMessageV2]
+      # @param brand [String] A unique identifier that represents the brand that should be used
+      #   for rendering the notification.
+      # @param data [Hash{String => String}] JSON that includes any data you want to pass to a message template.
+      #   The data will populate the corresponding template variables.
+      # @param event [String]
+      # @param locale [Hash{String => String}]
+      # @param override [Object] JSON that is merged into the request sent by Courier to the provider
+      #   to override properties or to gain access to features in the provider
+      #   API that are not natively supported by Courier.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Bulk::InboundBulkMessage]
+      def initialize(message: nil, brand: nil, data: nil, event: nil, locale: nil, override: nil,
+                     additional_properties: nil)
+        # @type [Bulk::InboundBulkMessageV2]
+        @message = message
+        # @type [String] A unique identifier that represents the brand that should be used
+        #   for rendering the notification.
+        @brand = brand
+        # @type [Hash{String => String}] JSON that includes any data you want to pass to a message template.
+        #   The data will populate the corresponding template variables.
+        @data = data
+        # @type [String]
+        @event = event
+        # @type [Hash{String => String}]
+        @locale = locale
+        # @type [Object] JSON that is merged into the request sent by Courier to the provider
+        #   to override properties or to gain access to features in the provider
+        #   API that are not natively supported by Courier.
+        @override = override
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of InboundBulkMessage
+      #
+      # @param json_object [JSON]
+      # @return [Bulk::InboundBulkMessage]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["message"].nil?
+          message = nil
+        else
+          message = parsed_json["message"].to_json
+          message = Bulk::InboundBulkMessageV2.from_json(json_object: message)
+        end
+        brand = struct.brand
+        data = struct.data
+        event = struct.event
+        locale = struct.locale
+        override = struct.override
+        new(message: message, brand: brand, data: data, event: event, locale: locale, override: override,
+            additional_properties: struct)
+      end
+
+      # Serialize an instance of InboundBulkMessage to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "message": @message,
+          "brand": @brand,
+          "data": @data,
+          "event": @event,
+          "locale": @locale,
+          "override": @override
+        }.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.message.nil? || Bulk::InboundBulkMessageV2.validate_raw(obj: obj.message)
+        obj.brand&.is_a?(String) != false || raise("Passed value for field obj.brand is not the expected type, validation failed.")
+        obj.data&.is_a?(Hash) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
+        obj.event&.is_a?(String) != false || raise("Passed value for field obj.event is not the expected type, validation failed.")
+        obj.locale&.is_a?(Hash) != false || raise("Passed value for field obj.locale is not the expected type, validation failed.")
+        obj.override&.is_a?(Object) != false || raise("Passed value for field obj.override is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/bulk/types/inbound_bulk_message_user.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "../../commons/types/recipient_preferences"
+require_relative "../../send/types/user_recipient"
+require "json"
+
+module Courier
+  class Bulk
+    class InboundBulkMessageUser
+      attr_reader :preferences, :profile, :recipient, :data, :to, :additional_properties
+
+      # @param preferences [Commons::RecipientPreferences]
+      # @param profile [Object]
+      # @param recipient [String]
+      # @param data [Object]
+      # @param to [Send::UserRecipient]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Bulk::InboundBulkMessageUser]
+      def initialize(preferences: nil, profile: nil, recipient: nil, data: nil, to: nil, additional_properties: nil)
+        # @type [Commons::RecipientPreferences]
+        @preferences = preferences
+        # @type [Object]
+        @profile = profile
+        # @type [String]
+        @recipient = recipient
+        # @type [Object]
+        @data = data
+        # @type [Send::UserRecipient]
+        @to = to
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of InboundBulkMessageUser
+      #
+      # @param json_object [JSON]
+      # @return [Bulk::InboundBulkMessageUser]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["preferences"].nil?
+          preferences = nil
+        else
+          preferences = parsed_json["preferences"].to_json
+          preferences = Commons::RecipientPreferences.from_json(json_object: preferences)
+        end
+        profile = struct.profile
+        recipient = struct.recipient
+        data = struct.data
+        if parsed_json["to"].nil?
+          to = nil
+        else
+          to = parsed_json["to"].to_json
+          to = Send::UserRecipient.from_json(json_object: to)
+        end
+        new(preferences: preferences, profile: profile, recipient: recipient, data: data, to: to,
+            additional_properties: struct)
+      end
+
+      # Serialize an instance of InboundBulkMessageUser to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "preferences": @preferences, "profile": @profile, "recipient": @recipient, "data": @data, "to": @to }.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.preferences.nil? || Commons::RecipientPreferences.validate_raw(obj: obj.preferences)
+        obj.profile&.is_a?(Object) != false || raise("Passed value for field obj.profile is not the expected type, validation failed.")
+        obj.recipient&.is_a?(String) != false || raise("Passed value for field obj.recipient is not the expected type, validation failed.")
+        obj.data&.is_a?(Object) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
+        obj.to.nil? || Send::UserRecipient.validate_raw(obj: obj.to)
+      end
+    end
+  end
+end