trycourier 1.10.0 → 3.0.0.pre.beta1

data/lib/trycourier/send/types/template_message.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require_relative "message_recipient"
+require_relative "message_data"
+require_relative "message_channels"
+require_relative "message_context"
+require_relative "message_metadata"
+require_relative "message_providers"
+require_relative "routing"
+require_relative "timeout"
+require_relative "delay"
+require_relative "expiry"
+require "json"
+
+module Courier
+  class Send
+    class TemplateMessage
+      attr_reader :template, :to, :data, :brand_id, :channels, :context, :metadata, :providers, :routing, :timeout,
+                  :delay, :expiry, :additional_properties
+
+      # @param template [String] The id of the notification template to be rendered and sent to the recipient(s).
+      #   This field or the content field must be supplied.
+      # @param to [Send::MessageRecipient] The recipient or a list of recipients of the message
+      # @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 [Send::TemplateMessage]
+      def initialize(template:, to:, 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 [String] The id of the notification template to be rendered and sent to the recipient(s).
+        #   This field or the content field must be supplied.
+        @template = template
+        # @type [Send::MessageRecipient] The recipient or a list of recipients of the message
+        @to = to
+        # @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 TemplateMessage
+      #
+      # @param json_object [JSON]
+      # @return [Send::TemplateMessage]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        template = struct.template
+        if parsed_json["to"].nil?
+          to = nil
+        else
+          to = parsed_json["to"].to_json
+          to = Send::MessageRecipient.from_json(json_object: to)
+        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(template: template, to: to, 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 TemplateMessage to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "template": @template,
+          "to": @to,
+          "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:)
+        obj.template.is_a?(String) != false || raise("Passed value for field obj.template is not the expected type, validation failed.")
+        Send::MessageRecipient.validate_raw(obj: obj.to)
+        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/send/types/text_align.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Courier
+  class Send
+    class TextAlign
+      LEFT = "left"
+      CENTER = "center"
+      RIGHT = "right"
+    end
+  end
+end

data/lib/trycourier/send/types/text_style.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Courier
+  class Send
+    class TextStyle
+      TEXT = "text"
+      H_1 = "h1"
+      H_2 = "h2"
+      SUBTEXT = "subtext"
+    end
+  end
+end

data/lib/trycourier/send/types/timeout.rb

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

data/lib/trycourier/send/types/timeouts.rb

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

data/lib/trycourier/send/types/tracking_override.rb

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

data/lib/trycourier/send/types/user_recipient.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require_relative "message_context"
+require_relative "message_data"
+require_relative "i_profile_preferences"
+require "json"
+
+module Courier
+  class Send
+    class UserRecipient
+      attr_reader :account_id, :context, :data, :email, :locale, :user_id, :phone_number, :preferences, :tenant_id,
+                  :additional_properties
+
+      # @param account_id [String] Use `tenant_id` instad.
+      # @param context [Send::MessageContext] Context information such as tenant_id to send the notification with.
+      # @param data [Send::MESSAGE_DATA]
+      # @param email [String]
+      # @param locale [String] The user's preferred ISO 639-1 language code.
+      # @param user_id [String]
+      # @param phone_number [String]
+      # @param preferences [Send::IProfilePreferences]
+      # @param tenant_id [String] An id of a tenant, [see tenants api docs](https://www.courier.com/docs/reference/tenants).
+      #   Will load brand, default preferences and any other base context data associated with this tenant.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Send::UserRecipient]
+      def initialize(account_id: nil, context: nil, data: nil, email: nil, locale: nil, user_id: nil,
+                     phone_number: nil, preferences: nil, tenant_id: nil, additional_properties: nil)
+        # @type [String] Use `tenant_id` instad.
+        @account_id = account_id
+        # @type [Send::MessageContext] Context information such as tenant_id to send the notification with.
+        @context = context
+        # @type [Send::MESSAGE_DATA]
+        @data = data
+        # @type [String]
+        @email = email
+        # @type [String] The user's preferred ISO 639-1 language code.
+        @locale = locale
+        # @type [String]
+        @user_id = user_id
+        # @type [String]
+        @phone_number = phone_number
+        # @type [Send::IProfilePreferences]
+        @preferences = preferences
+        # @type [String] An id of a tenant, [see tenants api docs](https://www.courier.com/docs/reference/tenants).
+        #   Will load brand, default preferences and any other base context data associated with this tenant.
+        @tenant_id = tenant_id
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of UserRecipient
+      #
+      # @param json_object [JSON]
+      # @return [Send::UserRecipient]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        account_id = struct.account_id
+        if parsed_json["context"].nil?
+          context = nil
+        else
+          context = parsed_json["context"].to_json
+          context = Send::MessageContext.from_json(json_object: context)
+        end
+        data = struct.data
+        email = struct.email
+        locale = struct.locale
+        user_id = struct.user_id
+        phone_number = struct.phone_number
+        if parsed_json["preferences"].nil?
+          preferences = nil
+        else
+          preferences = parsed_json["preferences"].to_json
+          preferences = Send::IProfilePreferences.from_json(json_object: preferences)
+        end
+        tenant_id = struct.tenant_id
+        new(account_id: account_id, context: context, data: data, email: email, locale: locale, user_id: user_id,
+            phone_number: phone_number, preferences: preferences, tenant_id: tenant_id, additional_properties: struct)
+      end
+
+      # Serialize an instance of UserRecipient to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "account_id": @account_id,
+          "context": @context,
+          "data": @data,
+          "email": @email,
+          "locale": @locale,
+          "user_id": @user_id,
+          "phone_number": @phone_number,
+          "preferences": @preferences,
+          "tenant_id": @tenant_id
+        }.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.account_id&.is_a?(String) != false || raise("Passed value for field obj.account_id is not the expected type, validation failed.")
+        obj.context.nil? || Send::MessageContext.validate_raw(obj: obj.context)
+        obj.data&.is_a?(Hash) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
+        obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+        obj.locale&.is_a?(String) != false || raise("Passed value for field obj.locale is not the expected type, validation failed.")
+        obj.user_id&.is_a?(String) != false || raise("Passed value for field obj.user_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.")
+        obj.preferences.nil? || Send::IProfilePreferences.validate_raw(obj: obj.preferences)
+        obj.tenant_id&.is_a?(String) != false || raise("Passed value for field obj.tenant_id is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/send/types/user_recipient_type.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Courier
+  class Send
+    class UserRecipientType
+      attr_reader :additional_properties
+
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Send::UserRecipientType]
+      def initialize(additional_properties: nil)
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of UserRecipientType
+      #
+      # @param json_object [JSON]
+      # @return [Send::UserRecipientType]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        new(additional_properties: struct)
+      end
+
+      # Serialize an instance of UserRecipientType to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {}.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:); end
+    end
+  end
+end

data/lib/trycourier/send/types/utm.rb

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

data/lib/trycourier/send/types/widget_background.rb

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