trycourier 2.0.0 → 3.0.0.pre.beta1

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

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+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 BaseMessage
+      attr_reader :data, :brand_id, :channels, :context, :metadata, :providers, :routing, :timeout, :delay, :expiry,
+                  :additional_properties
+
+      # @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::BaseMessage]
+      def initialize(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::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 BaseMessage
+      #
+      # @param json_object [JSON]
+      # @return [Send::BaseMessage]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        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(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 BaseMessage to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "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.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/base_social_presence.rb

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

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative "brand_template_override"
+require_relative "email_head"
+require_relative "email_footer"
+require_relative "email_header"
+require "json"
+
+module Courier
+  class Send
+    class BrandSettingsEmail
+      attr_reader :template_override, :head, :footer, :header, :additional_properties
+
+      # @param template_override [Send::BrandTemplateOverride]
+      # @param head [Send::EmailHead]
+      # @param footer [Send::EmailFooter]
+      # @param header [Send::EmailHeader]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Send::BrandSettingsEmail]
+      def initialize(template_override: nil, head: nil, footer: nil, header: nil, additional_properties: nil)
+        # @type [Send::BrandTemplateOverride]
+        @template_override = template_override
+        # @type [Send::EmailHead]
+        @head = head
+        # @type [Send::EmailFooter]
+        @footer = footer
+        # @type [Send::EmailHeader]
+        @header = header
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of BrandSettingsEmail
+      #
+      # @param json_object [JSON]
+      # @return [Send::BrandSettingsEmail]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["templateOverride"].nil?
+          template_override = nil
+        else
+          template_override = parsed_json["templateOverride"].to_json
+          template_override = Send::BrandTemplateOverride.from_json(json_object: template_override)
+        end
+        if parsed_json["head"].nil?
+          head = nil
+        else
+          head = parsed_json["head"].to_json
+          head = Send::EmailHead.from_json(json_object: head)
+        end
+        if parsed_json["footer"].nil?
+          footer = nil
+        else
+          footer = parsed_json["footer"].to_json
+          footer = Send::EmailFooter.from_json(json_object: footer)
+        end
+        if parsed_json["header"].nil?
+          header = nil
+        else
+          header = parsed_json["header"].to_json
+          header = Send::EmailHeader.from_json(json_object: header)
+        end
+        new(template_override: template_override, head: head, footer: footer, header: header,
+            additional_properties: struct)
+      end
+
+      # Serialize an instance of BrandSettingsEmail to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "templateOverride": @template_override, "head": @head, "footer": @footer, "header": @header }.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_override.nil? || Send::BrandTemplateOverride.validate_raw(obj: obj.template_override)
+        obj.head.nil? || Send::EmailHead.validate_raw(obj: obj.head)
+        obj.footer.nil? || Send::EmailFooter.validate_raw(obj: obj.footer)
+        obj.header.nil? || Send::EmailHeader.validate_raw(obj: obj.header)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative "in_app_placement"
+require_relative "widget_background"
+require_relative "../../brands/types/brand_colors"
+require_relative "icons"
+require_relative "preferences"
+require "json"
+
+module Courier
+  class Send
+    class BrandSettingsInApp
+      attr_reader :border_radius, :disable_message_icon, :font_family, :placement, :widget_background, :colors, :icons,
+                  :preferences, :additional_properties
+
+      # @param border_radius [String]
+      # @param disable_message_icon [Boolean]
+      # @param font_family [String]
+      # @param placement [Send::InAppPlacement]
+      # @param widget_background [Send::WidgetBackground]
+      # @param colors [Brands::BrandColors]
+      # @param icons [Send::Icons]
+      # @param preferences [Send::Preferences]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Send::BrandSettingsInApp]
+      def initialize(widget_background:, colors:, icons:, preferences:, border_radius: nil, disable_message_icon: nil,
+                     font_family: nil, placement: nil, additional_properties: nil)
+        # @type [String]
+        @border_radius = border_radius
+        # @type [Boolean]
+        @disable_message_icon = disable_message_icon
+        # @type [String]
+        @font_family = font_family
+        # @type [Send::InAppPlacement]
+        @placement = placement
+        # @type [Send::WidgetBackground]
+        @widget_background = widget_background
+        # @type [Brands::BrandColors]
+        @colors = colors
+        # @type [Send::Icons]
+        @icons = icons
+        # @type [Send::Preferences]
+        @preferences = preferences
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of BrandSettingsInApp
+      #
+      # @param json_object [JSON]
+      # @return [Send::BrandSettingsInApp]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        border_radius = struct.borderRadius
+        disable_message_icon = struct.disableMessageIcon
+        font_family = struct.fontFamily
+        placement = struct.placement
+        if parsed_json["widgetBackground"].nil?
+          widget_background = nil
+        else
+          widget_background = parsed_json["widgetBackground"].to_json
+          widget_background = Send::WidgetBackground.from_json(json_object: widget_background)
+        end
+        if parsed_json["colors"].nil?
+          colors = nil
+        else
+          colors = parsed_json["colors"].to_json
+          colors = Brands::BrandColors.from_json(json_object: colors)
+        end
+        if parsed_json["icons"].nil?
+          icons = nil
+        else
+          icons = parsed_json["icons"].to_json
+          icons = Send::Icons.from_json(json_object: icons)
+        end
+        if parsed_json["preferences"].nil?
+          preferences = nil
+        else
+          preferences = parsed_json["preferences"].to_json
+          preferences = Send::Preferences.from_json(json_object: preferences)
+        end
+        new(border_radius: border_radius, disable_message_icon: disable_message_icon, font_family: font_family,
+            placement: placement, widget_background: widget_background, colors: colors, icons: icons, preferences: preferences, additional_properties: struct)
+      end
+
+      # Serialize an instance of BrandSettingsInApp to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "borderRadius": @border_radius,
+          "disableMessageIcon": @disable_message_icon,
+          "fontFamily": @font_family,
+          "placement": @placement,
+          "widgetBackground": @widget_background,
+          "colors": @colors,
+          "icons": @icons,
+          "preferences": @preferences
+        }.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.border_radius&.is_a?(String) != false || raise("Passed value for field obj.border_radius is not the expected type, validation failed.")
+        obj.disable_message_icon&.is_a?(Boolean) != false || raise("Passed value for field obj.disable_message_icon is not the expected type, validation failed.")
+        obj.font_family&.is_a?(String) != false || raise("Passed value for field obj.font_family is not the expected type, validation failed.")
+        obj.placement&.is_a?(Send::InAppPlacement) != false || raise("Passed value for field obj.placement is not the expected type, validation failed.")
+        Send::WidgetBackground.validate_raw(obj: obj.widget_background)
+        Brands::BrandColors.validate_raw(obj: obj.colors)
+        Send::Icons.validate_raw(obj: obj.icons)
+        Send::Preferences.validate_raw(obj: obj.preferences)
+      end
+    end
+  end
+end

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

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

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

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