trycourier 2.0.0 → 3.0.0.pre.beta1

data/lib/trycourier/automations/types/automation_ad_hoc_invoke_params.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative "automation"
+require_relative "profile"
+require "json"
+
+module Courier
+  class Automations
+    class AutomationAdHocInvokeParams
+      attr_reader :automation, :brand, :data, :profile, :recipient, :template, :additional_properties
+
+      # @param automation [Automations::Automation]
+      # @param brand [String]
+      # @param data [Hash{String => String}]
+      # @param profile [Automations::PROFILE]
+      # @param recipient [String]
+      # @param template [String]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Automations::AutomationAdHocInvokeParams]
+      def initialize(automation:, brand: nil, data: nil, profile: nil, recipient: nil, template: nil,
+                     additional_properties: nil)
+        # @type [Automations::Automation]
+        @automation = automation
+        # @type [String]
+        @brand = brand
+        # @type [Hash{String => String}]
+        @data = data
+        # @type [Automations::PROFILE]
+        @profile = profile
+        # @type [String]
+        @recipient = recipient
+        # @type [String]
+        @template = template
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of AutomationAdHocInvokeParams
+      #
+      # @param json_object [JSON]
+      # @return [Automations::AutomationAdHocInvokeParams]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["automation"].nil?
+          automation = nil
+        else
+          automation = parsed_json["automation"].to_json
+          automation = Automations::Automation.from_json(json_object: automation)
+        end
+        brand = struct.brand
+        data = struct.data
+        profile = struct.profile
+        recipient = struct.recipient
+        template = struct.template
+        new(automation: automation, brand: brand, data: data, profile: profile, recipient: recipient,
+            template: template, additional_properties: struct)
+      end
+
+      # Serialize an instance of AutomationAdHocInvokeParams to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "automation": @automation,
+          "brand": @brand,
+          "data": @data,
+          "profile": @profile,
+          "recipient": @recipient,
+          "template": @template
+        }.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:)
+        Automations::Automation.validate_raw(obj: obj.automation)
+        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.profile&.is_a?(Object) != false || raise("Passed value for field obj.profile is not the expected type, validation failed.")
+        obj.recipient&.is_a?(String) != false || raise("Passed value for field obj.recipient is not the expected type, validation failed.")
+        obj.template&.is_a?(String) != false || raise("Passed value for field obj.template is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/automations/types/automation_cancel_step.rb

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

data/lib/trycourier/automations/types/automation_delay_step.rb

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

data/lib/trycourier/automations/types/automation_invoke_params.rb

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

data/lib/trycourier/automations/types/automation_invoke_response.rb

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

data/lib/trycourier/automations/types/automation_invoke_step.rb

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

data/lib/trycourier/automations/types/automation_invoke_template_params.rb

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

data/lib/trycourier/automations/types/automation_run_context.rb

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

data/lib/trycourier/automations/types/automation_send_list_step.rb

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