trycourier 2.0.0 → 3.0.0.pre.beta1

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

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

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Courier
+  class Commons
+    class MessageNotFound
+      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::MessageNotFound]
+      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 MessageNotFound
+      #
+      # @param json_object [JSON]
+      # @return [Commons::MessageNotFound]
+      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 MessageNotFound 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/not_found.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Courier
+  class Commons
+    class NotFound
+      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::NotFound]
+      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 NotFound
+      #
+      # @param json_object [JSON]
+      # @return [Commons::NotFound]
+      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 NotFound 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/notification_preference_details.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "preference_status"
+require_relative "rule"
+require_relative "channel_preference"
+require "json"
+
+module Courier
+  class Commons
+    class NotificationPreferenceDetails
+      attr_reader :status, :rules, :channel_preferences, :additional_properties
+
+      # @param status [Commons::PreferenceStatus]
+      # @param rules [Array<Commons::Rule>]
+      # @param channel_preferences [Array<Commons::ChannelPreference>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Commons::NotificationPreferenceDetails]
+      def initialize(status:, rules: nil, channel_preferences: nil, additional_properties: nil)
+        # @type [Commons::PreferenceStatus]
+        @status = status
+        # @type [Array<Commons::Rule>]
+        @rules = rules
+        # @type [Array<Commons::ChannelPreference>]
+        @channel_preferences = channel_preferences
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of NotificationPreferenceDetails
+      #
+      # @param json_object [JSON]
+      # @return [Commons::NotificationPreferenceDetails]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        status = struct.status
+        rules = parsed_json["rules"]&.map do |v|
+          v = v.to_json
+          Commons::Rule.from_json(json_object: v)
+        end
+        channel_preferences = parsed_json["channel_preferences"]&.map do |v|
+          v = v.to_json
+          Commons::ChannelPreference.from_json(json_object: v)
+        end
+        new(status: status, rules: rules, channel_preferences: channel_preferences, additional_properties: struct)
+      end
+
+      # Serialize an instance of NotificationPreferenceDetails to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "status": @status, "rules": @rules, "channel_preferences": @channel_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.status.is_a?(Commons::PreferenceStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.rules&.is_a?(Array) != false || raise("Passed value for field obj.rules is not the expected type, validation failed.")
+        obj.channel_preferences&.is_a?(Array) != false || raise("Passed value for field obj.channel_preferences is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Courier
+  class Commons
+    class PaymentRequired
+      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::PaymentRequired]
+      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 PaymentRequired
+      #
+      # @param json_object [JSON]
+      # @return [Commons::PaymentRequired]
+      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 PaymentRequired 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/preference_status.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Courier
+  class Commons
+    class PreferenceStatus
+      OPTED_IN = "OPTED_IN"
+      OPTED_OUT = "OPTED_OUT"
+      REQUIRED = "REQUIRED"
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Courier
+  class Commons
+    class UserTenantAssociation
+      attr_reader :user_id, :type, :tenant_id, :profile, :additional_properties
+
+      # @param user_id [String] User ID for the assocation between tenant and user
+      # @param type [String]
+      # @param tenant_id [String] Tenant ID for the assocation between tenant and user
+      # @param profile [Hash{String => String}]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Commons::UserTenantAssociation]
+      def initialize(user_id:, type:, tenant_id:, profile:, additional_properties: nil)
+        # @type [String] User ID for the assocation between tenant and user
+        @user_id = user_id
+        # @type [String]
+        @type = type
+        # @type [String] Tenant ID for the assocation between tenant and user
+        @tenant_id = tenant_id
+        # @type [Hash{String => String}]
+        @profile = profile
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of UserTenantAssociation
+      #
+      # @param json_object [JSON]
+      # @return [Commons::UserTenantAssociation]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        user_id = struct.user_id
+        type = struct.type
+        tenant_id = struct.tenant_id
+        profile = struct.profile
+        new(user_id: user_id, type: type, tenant_id: tenant_id, profile: profile, additional_properties: struct)
+      end
+
+      # Serialize an instance of UserTenantAssociation to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "user_id": @user_id, "type": @type, "tenant_id": @tenant_id, "profile": @profile }.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.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
+        obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        obj.tenant_id.is_a?(String) != false || raise("Passed value for field obj.tenant_id is not the expected type, validation failed.")
+        obj.profile.is_a?(Hash) != false || raise("Passed value for field obj.profile is not the expected type, validation failed.")
+      end
+    end
+  end
+end