trycourier 3.1.3 → 3.4.0.pre.alpha0

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

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

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require_relative "inbound_bulk_template_message"
-require_relative "inbound_bulk_content_message"
-
-module Courier
-  class Bulk
-    class InboundBulkMessageV2
-      # Deserialize a JSON object to an instance of InboundBulkMessageV2
-      #
-      # @param json_object [JSON]
-      # @return [Bulk::InboundBulkMessageV2]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        begin
-          Bulk::InboundBulkTemplateMessage.validate_raw(obj: struct)
-          return Bulk::InboundBulkTemplateMessage.from_json(json_object: json_object)
-        rescue StandardError
-          # noop
-        end
-        begin
-          Bulk::InboundBulkContentMessage.validate_raw(obj: struct)
-          return Bulk::InboundBulkContentMessage.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 Bulk::InboundBulkTemplateMessage.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return Bulk::InboundBulkContentMessage.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/bulk/types/inbound_bulk_template_message.rb

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

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "inbound_bulk_message"
-require_relative "bulk_job_status"
-require "json"
-
-module Courier
-  class Bulk
-    class JobDetails
-      attr_reader :definition, :enqueued, :failures, :received, :status, :additional_properties
-
-      # @param definition [Bulk::InboundBulkMessage]
-      # @param enqueued [Integer]
-      # @param failures [Integer]
-      # @param received [Integer]
-      # @param status [Bulk::BulkJobStatus]
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Bulk::JobDetails]
-      def initialize(definition:, enqueued:, failures:, received:, status:, additional_properties: nil)
-        # @type [Bulk::InboundBulkMessage]
-        @definition = definition
-        # @type [Integer]
-        @enqueued = enqueued
-        # @type [Integer]
-        @failures = failures
-        # @type [Integer]
-        @received = received
-        # @type [Bulk::BulkJobStatus]
-        @status = status
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
-        @additional_properties = additional_properties
-      end
-
-      # Deserialize a JSON object to an instance of JobDetails
-      #
-      # @param json_object [JSON]
-      # @return [Bulk::JobDetails]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        if parsed_json["definition"].nil?
-          definition = nil
-        else
-          definition = parsed_json["definition"].to_json
-          definition = Bulk::InboundBulkMessage.from_json(json_object: definition)
-        end
-        enqueued = struct.enqueued
-        failures = struct.failures
-        received = struct.received
-        status = struct.status
-        new(definition: definition, enqueued: enqueued, failures: failures, received: received, status: status,
-            additional_properties: struct)
-      end
-
-      # Serialize an instance of JobDetails to a JSON object
-      #
-      # @return [JSON]
-      def to_json(*_args)
-        {
-          "definition": @definition,
-          "enqueued": @enqueued,
-          "failures": @failures,
-          "received": @received,
-          "status": @status
-        }.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:)
-        Bulk::InboundBulkMessage.validate_raw(obj: obj.definition)
-        obj.enqueued.is_a?(Integer) != false || raise("Passed value for field obj.enqueued is not the expected type, validation failed.")
-        obj.failures.is_a?(Integer) != false || raise("Passed value for field obj.failures is not the expected type, validation failed.")
-        obj.received.is_a?(Integer) != false || raise("Passed value for field obj.received is not the expected type, validation failed.")
-        obj.status.is_a?(Bulk::BulkJobStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/trycourier/commons/types/already_exists.rb

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

data/lib/trycourier/commons/types/bad_request.rb

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

data/lib/trycourier/commons/types/base_error.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-module Courier
-  class Commons
-    class BaseError
-      attr_reader :message, :additional_properties
-
-      # @param message [String] A message describing the error that occurred.
-      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Commons::BaseError]
-      def initialize(message:, additional_properties: nil)
-        # @type [String] A message describing the error that occurred.
-        @message = message
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
-        @additional_properties = additional_properties
-      end
-
-      # Deserialize a JSON object to an instance of BaseError
-      #
-      # @param json_object [JSON]
-      # @return [Commons::BaseError]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        message = struct.message
-        new(message: message, additional_properties: struct)
-      end
-
-      # Serialize an instance of BaseError to a JSON object
-      #
-      # @return [JSON]
-      def to_json(*_args)
-        { "message": @message }.to_json
-      end
-
-      # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
-      #
-      # @param obj [Object]
-      # @return [Void]
-      def self.validate_raw(obj:)
-        obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
-      end
-    end
-  end
-end

data/lib/trycourier/commons/types/channel_classification.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Courier
-  class Commons
-    class ChannelClassification
-      DIRECT_MESSAGE = "direct_message"
-      EMAIL = "email"
-      PUSH = "push"
-      SMS = "sms"
-      WEBHOOK = "webhook"
-      INBOX = "inbox"
-    end
-  end
-end

data/lib/trycourier/commons/types/channel_preference.rb

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

data/lib/trycourier/commons/types/conflict.rb

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