trycourier 2.0.0 → 3.0.0.pre.beta1

data/lib/trycourier/lists/types/list_put_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative "../../commons/types/recipient_preferences"
+require "json"
+
+module Courier
+  class Lists
+    class ListPutParams
+      attr_reader :name, :preferences, :additional_properties
+
+      # @param name [String]
+      # @param preferences [Commons::RecipientPreferences]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lists::ListPutParams]
+      def initialize(name:, preferences: nil, additional_properties: nil)
+        # @type [String]
+        @name = name
+        # @type [Commons::RecipientPreferences]
+        @preferences = preferences
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of ListPutParams
+      #
+      # @param json_object [JSON]
+      # @return [Lists::ListPutParams]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        name = struct.name
+        if parsed_json["preferences"].nil?
+          preferences = nil
+        else
+          preferences = parsed_json["preferences"].to_json
+          preferences = Commons::RecipientPreferences.from_json(json_object: preferences)
+        end
+        new(name: name, preferences: preferences, additional_properties: struct)
+      end
+
+      # Serialize an instance of ListPutParams to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "name": @name, "preferences": @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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.preferences.nil? || Commons::RecipientPreferences.validate_raw(obj: obj.preferences)
+      end
+    end
+  end
+end

data/lib/trycourier/lists/types/list_subscription_recipient.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "../../commons/types/recipient_preferences"
+require "json"
+
+module Courier
+  class Lists
+    class ListSubscriptionRecipient
+      attr_reader :recipient_id, :created, :preferences, :additional_properties
+
+      # @param recipient_id [String]
+      # @param created [String]
+      # @param preferences [Commons::RecipientPreferences]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lists::ListSubscriptionRecipient]
+      def initialize(recipient_id:, created: nil, preferences: nil, additional_properties: nil)
+        # @type [String]
+        @recipient_id = recipient_id
+        # @type [String]
+        @created = created
+        # @type [Commons::RecipientPreferences]
+        @preferences = preferences
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of ListSubscriptionRecipient
+      #
+      # @param json_object [JSON]
+      # @return [Lists::ListSubscriptionRecipient]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        recipient_id = struct.recipientId
+        created = struct.created
+        if parsed_json["preferences"].nil?
+          preferences = nil
+        else
+          preferences = parsed_json["preferences"].to_json
+          preferences = Commons::RecipientPreferences.from_json(json_object: preferences)
+        end
+        new(recipient_id: recipient_id, created: created, preferences: preferences, additional_properties: struct)
+      end
+
+      # Serialize an instance of ListSubscriptionRecipient to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "recipientId": @recipient_id, "created": @created, "preferences": @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.recipient_id.is_a?(String) != false || raise("Passed value for field obj.recipient_id is not the expected type, validation failed.")
+        obj.created&.is_a?(String) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+        obj.preferences.nil? || Commons::RecipientPreferences.validate_raw(obj: obj.preferences)
+      end
+    end
+  end
+end

data/lib/trycourier/lists/types/put_subscriptions_recipient.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative "../../commons/types/recipient_preferences"
+require "json"
+
+module Courier
+  class Lists
+    class PutSubscriptionsRecipient
+      attr_reader :recipient_id, :preferences, :additional_properties
+
+      # @param recipient_id [String]
+      # @param preferences [Commons::RecipientPreferences]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lists::PutSubscriptionsRecipient]
+      def initialize(recipient_id:, preferences: nil, additional_properties: nil)
+        # @type [String]
+        @recipient_id = recipient_id
+        # @type [Commons::RecipientPreferences]
+        @preferences = preferences
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of PutSubscriptionsRecipient
+      #
+      # @param json_object [JSON]
+      # @return [Lists::PutSubscriptionsRecipient]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        recipient_id = struct.recipientId
+        if parsed_json["preferences"].nil?
+          preferences = nil
+        else
+          preferences = parsed_json["preferences"].to_json
+          preferences = Commons::RecipientPreferences.from_json(json_object: preferences)
+        end
+        new(recipient_id: recipient_id, preferences: preferences, additional_properties: struct)
+      end
+
+      # Serialize an instance of PutSubscriptionsRecipient to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "recipientId": @recipient_id, "preferences": @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.recipient_id.is_a?(String) != false || raise("Passed value for field obj.recipient_id is not the expected type, validation failed.")
+        obj.preferences.nil? || Commons::RecipientPreferences.validate_raw(obj: obj.preferences)
+      end
+    end
+  end
+end

data/lib/trycourier/messages/client.rb

@@ -0,0 +1,300 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/list_messages_response"
+require_relative "types/message_details"
+require_relative "types/message_history_response"
+require_relative "types/render_output_response"
+require "async"
+
+module Courier
+  class MessagesClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [MessagesClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # Fetch the statuses of messages you've previously sent.
+    #
+    # @param archived [Boolean] A boolean value that indicates whether archived messages should be included in the response.
+    # @param cursor [String] A unique identifier that allows for fetching the next set of message statuses.
+    # @param event [String] A unique identifier representing the event that was used to send the event.
+    # @param list [String] A unique identifier representing the list the message was sent to.
+    # @param message_id [String] A unique identifier representing the message_id returned from either /send or /send/list.
+    # @param notification [String] A unique identifier representing the notification that was used to send the event.
+    # @param recipient [String] A unique identifier representing the recipient associated with the requested profile.
+    # @param status [String] An indicator of the current status of the message. Multiple status values can be passed in.
+    # @param tags [String] A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in.
+    # @param enqueued_after [String] The enqueued datetime of a message to filter out messages received before.
+    # @param trace_id [String] The unique identifier used to trace the requests
+    # @param request_options [RequestOptions]
+    # @return [Messages::ListMessagesResponse]
+    def list(archived: nil, cursor: nil, event: nil, list: nil, message_id: nil, notification: nil, recipient: nil,
+             status: nil, tags: nil, enqueued_after: nil, trace_id: nil, request_options: nil)
+      response = @request_client.conn.get("/messages") do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        unless request_options&.authorization_token.nil?
+          req.headers["Authorization"] =
+            request_options.authorization_token
+        end
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "archived": archived,
+          "cursor": cursor,
+          "event": event,
+          "list": list,
+          "messageId": message_id,
+          "notification": notification,
+          "recipient": recipient,
+          "status": status,
+          "tags": tags,
+          "enqueued_after": enqueued_after,
+          "traceId": trace_id
+        }.compact
+      end
+      Messages::ListMessagesResponse.from_json(json_object: response.body)
+    end
+
+    # Fetch the status of a message you've previously sent.
+    #
+    # @param message_id [String] A unique identifier associated with the message you wish to retrieve (results from a send).
+    # @param request_options [RequestOptions]
+    # @return [Messages::MessageDetails]
+    def get(message_id:, request_options: nil)
+      response = @request_client.conn.get("/messages/#{message_id}") do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        unless request_options&.authorization_token.nil?
+          req.headers["Authorization"] =
+            request_options.authorization_token
+        end
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+      end
+      Messages::MessageDetails.from_json(json_object: response.body)
+    end
+
+    # Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either `200` status code for a successful cancellation or `409` status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below).
+    #
+    # @param message_id [String] A unique identifier representing the message ID
+    # @param request_options [IdempotencyRequestOptions]
+    # @return [Messages::MessageDetails]
+    def cancel(message_id:, request_options: nil)
+      response = @request_client.conn.post("/messages/#{message_id}/cancel") do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        unless request_options&.authorization_token.nil?
+          req.headers["Authorization"] =
+            request_options.authorization_token
+        end
+        req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
+        unless request_options&.idempotency_expiry.nil?
+          req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
+        end
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+      end
+      Messages::MessageDetails.from_json(json_object: response.body)
+    end
+
+    # Fetch the array of events of a message you've previously sent.
+    #
+    # @param message_id [String] A unique identifier representing the message ID
+    # @param type [String] A supported Message History type that will filter the events returned.
+    # @param request_options [RequestOptions]
+    # @return [Messages::MessageHistoryResponse]
+    def get_history(message_id:, type: nil, request_options: nil)
+      response = @request_client.conn.get("/messages/#{message_id}/history") do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        unless request_options&.authorization_token.nil?
+          req.headers["Authorization"] =
+            request_options.authorization_token
+        end
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "type": type }.compact
+      end
+      Messages::MessageHistoryResponse.from_json(json_object: response.body)
+    end
+
+    # @param message_id [String] A unique identifier associated with the message you wish to retrieve (results from a send).
+    # @param request_options [RequestOptions]
+    # @return [Messages::RenderOutputResponse]
+    def get_content(message_id:, request_options: nil)
+      response = @request_client.conn.get("/messages/#{message_id}/output") do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        unless request_options&.authorization_token.nil?
+          req.headers["Authorization"] =
+            request_options.authorization_token
+        end
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+      end
+      Messages::RenderOutputResponse.from_json(json_object: response.body)
+    end
+
+    # @param request_id [String] A unique identifier representing the request ID
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def archive(request_id:, request_options: nil)
+      @request_client.conn.put("/requests/#{request_id}/archive") do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        unless request_options&.authorization_token.nil?
+          req.headers["Authorization"] =
+            request_options.authorization_token
+        end
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+      end
+    end
+  end
+
+  class AsyncMessagesClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncMessagesClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # Fetch the statuses of messages you've previously sent.
+    #
+    # @param archived [Boolean] A boolean value that indicates whether archived messages should be included in the response.
+    # @param cursor [String] A unique identifier that allows for fetching the next set of message statuses.
+    # @param event [String] A unique identifier representing the event that was used to send the event.
+    # @param list [String] A unique identifier representing the list the message was sent to.
+    # @param message_id [String] A unique identifier representing the message_id returned from either /send or /send/list.
+    # @param notification [String] A unique identifier representing the notification that was used to send the event.
+    # @param recipient [String] A unique identifier representing the recipient associated with the requested profile.
+    # @param status [String] An indicator of the current status of the message. Multiple status values can be passed in.
+    # @param tags [String] A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in.
+    # @param enqueued_after [String] The enqueued datetime of a message to filter out messages received before.
+    # @param trace_id [String] The unique identifier used to trace the requests
+    # @param request_options [RequestOptions]
+    # @return [Messages::ListMessagesResponse]
+    def list(archived: nil, cursor: nil, event: nil, list: nil, message_id: nil, notification: nil, recipient: nil,
+             status: nil, tags: nil, enqueued_after: nil, trace_id: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/messages") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          unless request_options&.authorization_token.nil?
+            req.headers["Authorization"] =
+              request_options.authorization_token
+          end
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "archived": archived,
+            "cursor": cursor,
+            "event": event,
+            "list": list,
+            "messageId": message_id,
+            "notification": notification,
+            "recipient": recipient,
+            "status": status,
+            "tags": tags,
+            "enqueued_after": enqueued_after,
+            "traceId": trace_id
+          }.compact
+        end
+        Messages::ListMessagesResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Fetch the status of a message you've previously sent.
+    #
+    # @param message_id [String] A unique identifier associated with the message you wish to retrieve (results from a send).
+    # @param request_options [RequestOptions]
+    # @return [Messages::MessageDetails]
+    def get(message_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/messages/#{message_id}") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          unless request_options&.authorization_token.nil?
+            req.headers["Authorization"] =
+              request_options.authorization_token
+          end
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        end
+        Messages::MessageDetails.from_json(json_object: response.body)
+      end
+    end
+
+    # Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either `200` status code for a successful cancellation or `409` status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below).
+    #
+    # @param message_id [String] A unique identifier representing the message ID
+    # @param request_options [IdempotencyRequestOptions]
+    # @return [Messages::MessageDetails]
+    def cancel(message_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.post("/messages/#{message_id}/cancel") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          unless request_options&.authorization_token.nil?
+            req.headers["Authorization"] =
+              request_options.authorization_token
+          end
+          req.headers["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
+          unless request_options&.idempotency_expiry.nil?
+            req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
+          end
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        end
+        Messages::MessageDetails.from_json(json_object: response.body)
+      end
+    end
+
+    # Fetch the array of events of a message you've previously sent.
+    #
+    # @param message_id [String] A unique identifier representing the message ID
+    # @param type [String] A supported Message History type that will filter the events returned.
+    # @param request_options [RequestOptions]
+    # @return [Messages::MessageHistoryResponse]
+    def get_history(message_id:, type: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/messages/#{message_id}/history") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          unless request_options&.authorization_token.nil?
+            req.headers["Authorization"] =
+              request_options.authorization_token
+          end
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "type": type }.compact
+        end
+        Messages::MessageHistoryResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # @param message_id [String] A unique identifier associated with the message you wish to retrieve (results from a send).
+    # @param request_options [RequestOptions]
+    # @return [Messages::RenderOutputResponse]
+    def get_content(message_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/messages/#{message_id}/output") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          unless request_options&.authorization_token.nil?
+            req.headers["Authorization"] =
+              request_options.authorization_token
+          end
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        end
+        Messages::RenderOutputResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # @param request_id [String] A unique identifier representing the request ID
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def archive(request_id:, request_options: nil)
+      Async do
+        @request_client.conn.put("/requests/#{request_id}/archive") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          unless request_options&.authorization_token.nil?
+            req.headers["Authorization"] =
+              request_options.authorization_token
+          end
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/messages/types/list_messages_response.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "../../commons/types/paging"
+require_relative "message_details"
+require "json"
+
+module Courier
+  class Messages
+    class ListMessagesResponse
+      attr_reader :paging, :results, :additional_properties
+
+      # @param paging [Commons::Paging] Paging information for the result set.
+      # @param results [Array<Messages::MessageDetails>] An array of messages with their details.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Messages::ListMessagesResponse]
+      def initialize(paging:, results:, additional_properties: nil)
+        # @type [Commons::Paging] Paging information for the result set.
+        @paging = paging
+        # @type [Array<Messages::MessageDetails>] An array of messages with their details.
+        @results = results
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of ListMessagesResponse
+      #
+      # @param json_object [JSON]
+      # @return [Messages::ListMessagesResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["paging"].nil?
+          paging = nil
+        else
+          paging = parsed_json["paging"].to_json
+          paging = Commons::Paging.from_json(json_object: paging)
+        end
+        results = parsed_json["results"]&.map do |v|
+          v = v.to_json
+          Messages::MessageDetails.from_json(json_object: v)
+        end
+        new(paging: paging, results: results, additional_properties: struct)
+      end
+
+      # Serialize an instance of ListMessagesResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "paging": @paging, "results": @results }.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:)
+        Commons::Paging.validate_raw(obj: obj.paging)
+        obj.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/messages/types/message_details.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require_relative "message_status"
+require_relative "reason"
+require "json"
+
+module Courier
+  class Messages
+    class MessageDetails
+      attr_reader :id, :status, :enqueued, :sent, :delivered, :opened, :clicked, :recipient, :event, :notification,
+                  :error, :reason, :additional_properties
+
+      # @param id [String] A unique identifier associated with the message you wish to retrieve (results from a send).
+      # @param status [Messages::MessageStatus] The current status of the message.
+      # @param enqueued [Integer] A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.
+      # @param sent [Integer] A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.
+      # @param delivered [Integer] A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.
+      # @param opened [Integer] A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.
+      # @param clicked [Integer] A UTC timestamp at which the recipient clicked on a tracked link for the first time. Stored as a millisecond representation of the Unix epoch.
+      # @param recipient [String] A unique identifier associated with the recipient of the delivered message.
+      # @param event [String] A unique identifier associated with the event of the delivered message.
+      # @param notification [String] A unique identifier associated with the notification of the delivered message.
+      # @param error [String] A message describing the error that occurred.
+      # @param reason [Messages::Reason] The reason for the current status of the message.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Messages::MessageDetails]
+      def initialize(id:, status:, enqueued:, sent:, delivered:, opened:, clicked:, recipient:, event:, notification:,
+                     error: nil, reason: nil, additional_properties: nil)
+        # @type [String] A unique identifier associated with the message you wish to retrieve (results from a send).
+        @id = id
+        # @type [Messages::MessageStatus] The current status of the message.
+        @status = status
+        # @type [Integer] A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.
+        @enqueued = enqueued
+        # @type [Integer] A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.
+        @sent = sent
+        # @type [Integer] A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.
+        @delivered = delivered
+        # @type [Integer] A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.
+        @opened = opened
+        # @type [Integer] A UTC timestamp at which the recipient clicked on a tracked link for the first time. Stored as a millisecond representation of the Unix epoch.
+        @clicked = clicked
+        # @type [String] A unique identifier associated with the recipient of the delivered message.
+        @recipient = recipient
+        # @type [String] A unique identifier associated with the event of the delivered message.
+        @event = event
+        # @type [String] A unique identifier associated with the notification of the delivered message.
+        @notification = notification
+        # @type [String] A message describing the error that occurred.
+        @error = error
+        # @type [Messages::Reason] The reason for the current status of the message.
+        @reason = reason
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of MessageDetails
+      #
+      # @param json_object [JSON]
+      # @return [Messages::MessageDetails]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        id = struct.id
+        status = struct.status
+        enqueued = struct.enqueued
+        sent = struct.sent
+        delivered = struct.delivered
+        opened = struct.opened
+        clicked = struct.clicked
+        recipient = struct.recipient
+        event = struct.event
+        notification = struct.notification
+        error = struct.error
+        reason = struct.reason
+        new(id: id, status: status, enqueued: enqueued, sent: sent, delivered: delivered, opened: opened,
+            clicked: clicked, recipient: recipient, event: event, notification: notification, error: error, reason: reason, additional_properties: struct)
+      end
+
+      # Serialize an instance of MessageDetails to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "id": @id,
+          "status": @status,
+          "enqueued": @enqueued,
+          "sent": @sent,
+          "delivered": @delivered,
+          "opened": @opened,
+          "clicked": @clicked,
+          "recipient": @recipient,
+          "event": @event,
+          "notification": @notification,
+          "error": @error,
+          "reason": @reason
+        }.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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.status.is_a?(Messages::MessageStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.enqueued.is_a?(Integer) != false || raise("Passed value for field obj.enqueued is not the expected type, validation failed.")
+        obj.sent.is_a?(Integer) != false || raise("Passed value for field obj.sent is not the expected type, validation failed.")
+        obj.delivered.is_a?(Integer) != false || raise("Passed value for field obj.delivered is not the expected type, validation failed.")
+        obj.opened.is_a?(Integer) != false || raise("Passed value for field obj.opened is not the expected type, validation failed.")
+        obj.clicked.is_a?(Integer) != false || raise("Passed value for field obj.clicked 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.event.is_a?(String) != false || raise("Passed value for field obj.event is not the expected type, validation failed.")
+        obj.notification.is_a?(String) != false || raise("Passed value for field obj.notification is not the expected type, validation failed.")
+        obj.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
+        obj.reason&.is_a?(Messages::Reason) != false || raise("Passed value for field obj.reason is not the expected type, validation failed.")
+      end
+    end
+  end
+end