trycourier 3.1.3 → 3.4.0.pre.alpha0

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

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Courier
-  class Send
-    LOCALES = Hash
-  end
-end

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

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

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require_relative "content_message"
-require_relative "template_message"
-
-module Courier
-  class Send
-    class Message
-      # Deserialize a JSON object to an instance of Message
-      #
-      # @param json_object [JSON]
-      # @return [Send::Message]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        begin
-          Send::ContentMessage.validate_raw(obj: struct)
-          return Send::ContentMessage.from_json(json_object: json_object)
-        rescue StandardError
-          # noop
-        end
-        begin
-          Send::TemplateMessage.validate_raw(obj: struct)
-          return Send::TemplateMessage.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::ContentMessage.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return Send::TemplateMessage.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/message_channel_email_override.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "attachment"
-require_relative "../../brands/types/brand"
-require_relative "tracking_override"
-require "json"
-
-module Courier
-  class Send
-    class MessageChannelEmailOverride
-      attr_reader :attachments, :bcc, :brand, :cc, :from, :html, :reply_to, :subject, :text, :tracking,
-                  :additional_properties
-
-      # @param attachments [Array<Send::ATTACHMENT>]
-      # @param bcc [String]
-      # @param brand [Brands::Brand]
-      # @param cc [String]
-      # @param from [String]
-      # @param html [String]
-      # @param reply_to [String]
-      # @param subject [String]
-      # @param text [String]
-      # @param tracking [Send::TrackingOverride]
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Send::MessageChannelEmailOverride]
-      def initialize(tracking:, attachments: nil, bcc: nil, brand: nil, cc: nil, from: nil, html: nil, reply_to: nil,
-                     subject: nil, text: nil, additional_properties: nil)
-        # @type [Array<Send::ATTACHMENT>]
-        @attachments = attachments
-        # @type [String]
-        @bcc = bcc
-        # @type [Brands::Brand]
-        @brand = brand
-        # @type [String]
-        @cc = cc
-        # @type [String]
-        @from = from
-        # @type [String]
-        @html = html
-        # @type [String]
-        @reply_to = reply_to
-        # @type [String]
-        @subject = subject
-        # @type [String]
-        @text = text
-        # @type [Send::TrackingOverride]
-        @tracking = tracking
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
-        @additional_properties = additional_properties
-      end
-
-      # Deserialize a JSON object to an instance of MessageChannelEmailOverride
-      #
-      # @param json_object [JSON]
-      # @return [Send::MessageChannelEmailOverride]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        attachments = struct.attachments
-        bcc = struct.bcc
-        if parsed_json["brand"].nil?
-          brand = nil
-        else
-          brand = parsed_json["brand"].to_json
-          brand = Brands::Brand.from_json(json_object: brand)
-        end
-        cc = struct.cc
-        from = struct.from
-        html = struct.html
-        reply_to = struct.reply_to
-        subject = struct.subject
-        text = struct.text
-        if parsed_json["tracking"].nil?
-          tracking = nil
-        else
-          tracking = parsed_json["tracking"].to_json
-          tracking = Send::TrackingOverride.from_json(json_object: tracking)
-        end
-        new(attachments: attachments, bcc: bcc, brand: brand, cc: cc, from: from, html: html, reply_to: reply_to,
-            subject: subject, text: text, tracking: tracking, additional_properties: struct)
-      end
-
-      # Serialize an instance of MessageChannelEmailOverride to a JSON object
-      #
-      # @return [JSON]
-      def to_json(*_args)
-        {
-          "attachments": @attachments,
-          "bcc": @bcc,
-          "brand": @brand,
-          "cc": @cc,
-          "from": @from,
-          "html": @html,
-          "reply_to": @reply_to,
-          "subject": @subject,
-          "text": @text,
-          "tracking": @tracking
-        }.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.attachments&.is_a?(Array) != false || raise("Passed value for field obj.attachments is not the expected type, validation failed.")
-        obj.bcc&.is_a?(String) != false || raise("Passed value for field obj.bcc is not the expected type, validation failed.")
-        obj.brand.nil? || Brands::Brand.validate_raw(obj: obj.brand)
-        obj.cc&.is_a?(String) != false || raise("Passed value for field obj.cc is not the expected type, validation failed.")
-        obj.from&.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
-        obj.html&.is_a?(String) != false || raise("Passed value for field obj.html is not the expected type, validation failed.")
-        obj.reply_to&.is_a?(String) != false || raise("Passed value for field obj.reply_to is not the expected type, validation failed.")
-        obj.subject&.is_a?(String) != false || raise("Passed value for field obj.subject is not the expected type, validation failed.")
-        obj.text&.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
-        Send::TrackingOverride.validate_raw(obj: obj.tracking)
-      end
-    end
-  end
-end

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Courier
-  class Send
-    MESSAGE_CHANNELS = Hash
-  end
-end

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

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-module Courier
-  class Send
-    class MessageContext
-      attr_reader :tenant_id, :additional_properties
-
-      # @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::MessageContext]
-      def initialize(tenant_id: nil, additional_properties: nil)
-        # @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 MessageContext
-      #
-      # @param json_object [JSON]
-      # @return [Send::MessageContext]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        tenant_id = struct.tenant_id
-        new(tenant_id: tenant_id, additional_properties: struct)
-      end
-
-      # Serialize an instance of MessageContext to a JSON object
-      #
-      # @return [JSON]
-      def to_json(*_args)
-        { "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.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/message_data.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Courier
-  class Send
-    MESSAGE_DATA = Hash
-  end
-end

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

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "utm"
-require "json"
-
-module Courier
-  class Send
-    class MessageMetadata
-      attr_reader :event, :tags, :utm, :trace_id, :additional_properties
-
-      # @param event [String] An arbitrary string to tracks the event that generated this request (e.g. 'signup').
-      # @param tags [Array<String>] An array of up to 9 tags you wish to associate with this request (and corresponding messages) for later analysis. Individual tags cannot be more than 30 characters in length.
-      # @param utm [Send::Utm] Identify the campaign that refers traffic to a specific website, and attributes the browser's website session.
-      # @param trace_id [String] A unique ID used to correlate this request to processing on your servers. Note: Courier does not verify the uniqueness of this ID.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Send::MessageMetadata]
-      def initialize(event: nil, tags: nil, utm: nil, trace_id: nil, additional_properties: nil)
-        # @type [String] An arbitrary string to tracks the event that generated this request (e.g. 'signup').
-        @event = event
-        # @type [Array<String>] An array of up to 9 tags you wish to associate with this request (and corresponding messages) for later analysis. Individual tags cannot be more than 30 characters in length.
-        @tags = tags
-        # @type [Send::Utm] Identify the campaign that refers traffic to a specific website, and attributes the browser's website session.
-        @utm = utm
-        # @type [String] A unique ID used to correlate this request to processing on your servers. Note: Courier does not verify the uniqueness of this ID.
-        @trace_id = trace_id
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
-        @additional_properties = additional_properties
-      end
-
-      # Deserialize a JSON object to an instance of MessageMetadata
-      #
-      # @param json_object [JSON]
-      # @return [Send::MessageMetadata]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        event = struct.event
-        tags = struct.tags
-        if parsed_json["utm"].nil?
-          utm = nil
-        else
-          utm = parsed_json["utm"].to_json
-          utm = Send::Utm.from_json(json_object: utm)
-        end
-        trace_id = struct.trace_id
-        new(event: event, tags: tags, utm: utm, trace_id: trace_id, additional_properties: struct)
-      end
-
-      # Serialize an instance of MessageMetadata to a JSON object
-      #
-      # @return [JSON]
-      def to_json(*_args)
-        { "event": @event, "tags": @tags, "utm": @utm, "trace_id": @trace_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.event&.is_a?(String) != false || raise("Passed value for field obj.event is not the expected type, validation failed.")
-        obj.tags&.is_a?(Array) != false || raise("Passed value for field obj.tags is not the expected type, validation failed.")
-        obj.utm.nil? || Send::Utm.validate_raw(obj: obj.utm)
-        obj.trace_id&.is_a?(String) != false || raise("Passed value for field obj.trace_id is not the expected type, validation failed.")
-      end
-    end
-  end
-end

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Courier
-  class Send
-    MESSAGE_PROVIDERS = Hash
-  end
-end

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

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "metadata"
-require "json"
-
-module Courier
-  class Send
-    class MessageProvidersType
-      attr_reader :override, :if_, :timeouts, :metadata, :additional_properties
-
-      # @param override [Hash{String => String}] Provider specific overrides.
-      # @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 [Integer]
-      # @param metadata [Send::Metadata]
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Send::MessageProvidersType]
-      def initialize(override: nil, if_: nil, timeouts: nil, metadata: nil, additional_properties: nil)
-        # @type [Hash{String => String}] Provider specific overrides.
-        @override = override
-        # @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 [Integer]
-        @timeouts = timeouts
-        # @type [Send::Metadata]
-        @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 MessageProvidersType
-      #
-      # @param json_object [JSON]
-      # @return [Send::MessageProvidersType]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        override = struct.override
-        if_ = struct.if
-        timeouts = struct.timeouts
-        if parsed_json["metadata"].nil?
-          metadata = nil
-        else
-          metadata = parsed_json["metadata"].to_json
-          metadata = Send::Metadata.from_json(json_object: metadata)
-        end
-        new(override: override, if_: if_, timeouts: timeouts, metadata: metadata, additional_properties: struct)
-      end
-
-      # Serialize an instance of MessageProvidersType to a JSON object
-      #
-      # @return [JSON]
-      def to_json(*_args)
-        { "override": @override, "if": @if_, "timeouts": @timeouts, "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.override&.is_a?(Hash) != false || raise("Passed value for field obj.override 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&.is_a?(Integer) != false || raise("Passed value for field obj.timeouts is not the expected type, validation failed.")
-        obj.metadata.nil? || Send::Metadata.validate_raw(obj: obj.metadata)
-      end
-    end
-  end
-end

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

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-require "json"
-require_relative "recipient"
-
-module Courier
-  class Send
-    class MessageRecipient
-      # Deserialize a JSON object to an instance of MessageRecipient
-      #
-      # @param json_object [JSON] 
-      # @return [Send::MessageRecipient]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        begin
-          Send::Recipient.validate_raw(obj: struct)
-          return Send::Recipient.from_json(json_object: json_object)
-        rescue StandardError
-          # noop
-        end
-        begin
-          struct.is_a?(Array) != false || raise("Passed value for field struct is not the expected type, validation failed.")
-          return unless json_object.nil?
-          json_object.map do |v|
-            v = v.to_json
-            Send::Recipient.from_json(json_object: v)
-          end
-        else
-          nil
-        end
-        rescue StandardError
-          # noop
-        end
-        return 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::Recipient.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return obj.is_a?(Array) != false || raise("Passed value for field obj is not the expected type, validation failed.")
-        rescue StandardError
-          # noop
-        end
-        raise("Passed value matched no type within the union, validation failed.")
-      end
-    end
-  end
-end

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

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "utm"
-require "json"
-
-module Courier
-  class Send
-    class Metadata
-      attr_reader :utm, :additional_properties
-
-      # @param utm [Send::Utm]
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Send::Metadata]
-      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 Metadata
-      #
-      # @param json_object [JSON]
-      # @return [Send::Metadata]
-      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 Metadata 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/ms_teams_recipient.rb

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

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

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Courier
-  class Send
-    class Override
-      MESSAGE_CHANNEL_EMAIL_OVERRIDE = "MessageChannelEmailOverride"
-      MESSAGE_CHANNEL_PUSH_OVERRIDE = "MessageChannelPushOverride"
-    end
-  end
-end