trycourier 1.10.0 → 3.0.0.pre.beta1

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require_relative "brand_template"
+require "json"
+
+module Courier
+  class Send
+    class BrandTemplateOverride
+      attr_reader :mjml, :footer_background_color, :footer_full_width, :background_color, :blocks_background_color,
+                  :enabled, :footer, :head, :header, :width, :additional_properties
+
+      # @param mjml [Send::BrandTemplate]
+      # @param footer_background_color [String]
+      # @param footer_full_width [Boolean]
+      # @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::BrandTemplateOverride]
+      def initialize(mjml:, enabled:, footer_background_color: nil, footer_full_width: nil, background_color: nil,
+                     blocks_background_color: nil, footer: nil, head: nil, header: nil, width: nil, additional_properties: nil)
+        # @type [Send::BrandTemplate]
+        @mjml = mjml
+        # @type [String]
+        @footer_background_color = footer_background_color
+        # @type [Boolean]
+        @footer_full_width = footer_full_width
+        # @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 BrandTemplateOverride
+      #
+      # @param json_object [JSON]
+      # @return [Send::BrandTemplateOverride]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["mjml"].nil?
+          mjml = nil
+        else
+          mjml = parsed_json["mjml"].to_json
+          mjml = Send::BrandTemplate.from_json(json_object: mjml)
+        end
+        footer_background_color = struct.footerBackgroundColor
+        footer_full_width = struct.footerFullWidth
+        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(mjml: mjml, footer_background_color: footer_background_color, footer_full_width: footer_full_width,
+            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 BrandTemplateOverride to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "mjml": @mjml,
+          "footerBackgroundColor": @footer_background_color,
+          "footerFullWidth": @footer_full_width,
+          "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:)
+        Send::BrandTemplate.validate_raw(obj: obj.mjml)
+        obj.footer_background_color&.is_a?(String) != false || raise("Passed value for field obj.footer_background_color is not the expected type, validation failed.")
+        obj.footer_full_width&.is_a?(Boolean) != false || raise("Passed value for field obj.footer_full_width is not the expected type, validation failed.")
+        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

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require_relative "routing_method"
+require_relative "timeouts"
+require_relative "override"
+require_relative "channel_metadata"
+require "json"
+
+module Courier
+  class Send
+    class Channel
+      attr_reader :brand_id, :providers, :routing_method, :if_, :timeouts, :override, :metadata, :additional_properties
+
+      # @param brand_id [String] Id of the brand that should be used for rendering the message.
+      #   If not specified, the brand configured as default brand will be used.
+      # @param providers [Array<String>] A list of providers enabled for this channel. Courier will select
+      #   one provider to send through unless routing_method is set to all.
+      # @param routing_method [Send::RoutingMethod] The method for selecting the providers to send the message with.
+      #   Single will send to one of the available providers for this channel,
+      #   all will send the message through all channels. Defaults to `single`.
+      # @param if_ [String] A JavaScript conditional expression to determine if the message should
+      #   be sent through the channel. Has access to the data and profile object.
+      #   For example, `data.name === profile.name`
+      # @param timeouts [Send::Timeouts]
+      # @param override [Send::Override] Channel specific overrides.
+      # @param metadata [Send::ChannelMetadata]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Send::Channel]
+      def initialize(brand_id: nil, providers: nil, routing_method: nil, if_: nil, timeouts: nil, override: nil,
+                     metadata: nil, additional_properties: nil)
+        # @type [String] Id of the brand that should be used for rendering the message.
+        #   If not specified, the brand configured as default brand will be used.
+        @brand_id = brand_id
+        # @type [Array<String>] A list of providers enabled for this channel. Courier will select
+        #   one provider to send through unless routing_method is set to all.
+        @providers = providers
+        # @type [Send::RoutingMethod] The method for selecting the providers to send the message with.
+        #   Single will send to one of the available providers for this channel,
+        #   all will send the message through all channels. Defaults to `single`.
+        @routing_method = routing_method
+        # @type [String] A JavaScript conditional expression to determine if the message should
+        #   be sent through the channel. Has access to the data and profile object.
+        #   For example, `data.name === profile.name`
+        @if_ = if_
+        # @type [Send::Timeouts]
+        @timeouts = timeouts
+        # @type [Send::Override] Channel specific overrides.
+        @override = override
+        # @type [Send::ChannelMetadata]
+        @metadata = metadata
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of Channel
+      #
+      # @param json_object [JSON]
+      # @return [Send::Channel]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        brand_id = struct.brand_id
+        providers = struct.providers
+        routing_method = struct.routing_method
+        if_ = struct.if
+        if parsed_json["timeouts"].nil?
+          timeouts = nil
+        else
+          timeouts = parsed_json["timeouts"].to_json
+          timeouts = Send::Timeouts.from_json(json_object: timeouts)
+        end
+        override = struct.override
+        if parsed_json["metadata"].nil?
+          metadata = nil
+        else
+          metadata = parsed_json["metadata"].to_json
+          metadata = Send::ChannelMetadata.from_json(json_object: metadata)
+        end
+        new(brand_id: brand_id, providers: providers, routing_method: routing_method, if_: if_, timeouts: timeouts,
+            override: override, metadata: metadata, additional_properties: struct)
+      end
+
+      # Serialize an instance of Channel to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "brand_id": @brand_id,
+          "providers": @providers,
+          "routing_method": @routing_method,
+          "if": @if_,
+          "timeouts": @timeouts,
+          "override": @override,
+          "metadata": @metadata
+        }.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.brand_id&.is_a?(String) != false || raise("Passed value for field obj.brand_id is not the expected type, validation failed.")
+        obj.providers&.is_a?(Array) != false || raise("Passed value for field obj.providers is not the expected type, validation failed.")
+        obj.routing_method&.is_a?(Send::RoutingMethod) != false || raise("Passed value for field obj.routing_method is not the expected type, validation failed.")
+        obj.if_&.is_a?(String) != false || raise("Passed value for field obj.if_ is not the expected type, validation failed.")
+        obj.timeouts.nil? || Send::Timeouts.validate_raw(obj: obj.timeouts)
+        obj.override&.is_a?(Send::Override) != false || raise("Passed value for field obj.override is not the expected type, validation failed.")
+        obj.metadata.nil? || Send::ChannelMetadata.validate_raw(obj: obj.metadata)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Courier
+  class Send
+    class ChannelSource
+      SUBSCRIPTION = "subscription"
+      LIST = "list"
+      RECIPIENT = "recipient"
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "elemental_content"
+require_relative "elemental_content_sugar"
+
+module Courier
+  class Send
+    class Content
+      # Deserialize a JSON object to an instance of Content
+      #
+      # @param json_object [JSON]
+      # @return [Send::Content]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Send::ElementalContent.validate_raw(obj: struct)
+          return Send::ElementalContent.from_json(json_object: json_object)
+        rescue StandardError
+          # noop
+        end
+        begin
+          Send::ElementalContentSugar.validate_raw(obj: struct)
+          return Send::ElementalContentSugar.from_json(json_object: json_object)
+        rescue StandardError
+          # noop
+        end
+        struct
+      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:)
+        begin
+          return Send::ElementalContent.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Send::ElementalContentSugar.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require_relative "content"
+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
+    # 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 ContentMessage
+      attr_reader :content, :to, :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 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::ContentMessage]
+      def initialize(content:, 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 [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::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 ContentMessage
+      #
+      # @param json_object [JSON]
+      # @return [Send::ContentMessage]
+      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
+        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(content: content, 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 ContentMessage to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "content": @content,
+          "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:)
+        Send::Content.validate_raw(obj: obj.content)
+        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/criteria.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Courier
+  class Send
+    class Criteria
+      NO_ESCALATION = "no-escalation"
+      DELIVERED = "delivered"
+      VIEWED = "viewed"
+      ENGAGED = "engaged"
+    end
+  end
+end

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

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