mailosaur 7.12.0 → 7.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2638a9fd82a043fbca71f70ecd4b044140c89d047c887115e066ed5835fa13a7
-  data.tar.gz: 78056da25a3d202acc63a0e58f46964f0e99c88d48f7e486414bcfd8b5aea18c
+  metadata.gz: 0c417909e984bf0a87b874005ad64189ad558f7d84c684fb611f67acbb65e4c0
+  data.tar.gz: 14b33b02313b33441b8b81a38b20a076a4f4d4f3cf9d75c10bf647e19e7f9225
 SHA512:
-  metadata.gz: 3ecf79eea4f2797c59bc248f42f20dc89e06abc758c4498a510dfaea7b8741ba14d94267efc561bdbfba701418470ce03a5d2c4eef7d4e177eb43e0a74d1a915
-  data.tar.gz: 369d254a0d4fe8a1c89b39f3891ac199fe0683f15ec91cc4c79a3738afa2b6b3a49c441c1ca9b1278d9bea4b38de2c5d3ed89c55abf293dbc9900abf3833b57a
+  metadata.gz: f3ee70bc3325a97b85affc84f2ed0e72ed6e7ec02bb684fed6894d88ad4a4b74b46e593ac07b6a6ba6e3a1458ef76576cfb715096c04f971a0c2c45a336bf355
+  data.tar.gz: e35f4d3da9895285738241c72f8aa0b40b7da76ed298f83cae7a007222386ec20bdaee136f4c3658f94823786568dc553db05418f8a4da56627fb14bb8412290

data/lib/Mailosaur/files.rb

@@ -43,5 +43,21 @@ module Mailosaur
       @handle_http_error.call(response) unless response.status == 200
       response.body
     end
+
+    #
+    # Download an email preview
+    #
+    # Downloads a screenshot of your email rendered in a real email client. Simply supply
+    # the unique identifier for the required preview.
+    #
+    # @param id The identifier of the email preview to be downloaded.
+    #
+    # @return [NOT_IMPLEMENTED] operation results.
+    #
+    def get_preview(id)
+      response = conn.get "api/files/previews/#{id}"
+      @handle_http_error.call(response) unless response.status == 200
+      response.body
+    end
   end
 end

data/lib/Mailosaur/messages.rb

@@ -234,5 +234,22 @@ module Mailosaur
       model = JSON.parse(response.body)
       Mailosaur::Models::Message.new(model)
     end
+
+    #
+    # Generate email previews.
+    #
+    # Generates screenshots of an email rendered in the specified email clients.
+    #
+    # @param id [String] The identifier of the email to preview.
+    # @param options [PreviewRequestOptions] The options with which to generate previews.
+    #
+    # @return [PreviewListResult] operation result.
+    #
+    def generate_previews(id, options)
+      response = conn.post "api/messages/#{id}/previews", options.to_json
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.parse(response.body)
+      Mailosaur::Models::PreviewListResult.new(model)
+    end
   end
 end

data/lib/Mailosaur/models/preview.rb

@@ -0,0 +1,20 @@
+module Mailosaur
+  module Models
+    class Preview < BaseModel
+      def initialize(data = {})
+        @id = data['id']
+        @email_client = data['emailClient']
+        @disable_images = data['disableImages']
+      end
+
+      # @return [String] Unique identifier for the email preview.
+      attr_accessor :id
+
+      # @return [String] The email client the preview was generated with.
+      attr_accessor :email_client
+
+      # @return [Boolean] True if images were disabled in the preview.
+      attr_accessor :disable_images
+    end
+  end
+end

data/lib/Mailosaur/models/preview_email_client.rb

@@ -0,0 +1,36 @@
+module Mailosaur
+  module Models
+    class PreviewEmailClient < BaseModel
+      def initialize(data = {})
+        @id = data['id']
+        @name = data['id']
+        @platform_group = data['id']
+        @platform_type = data['id']
+        @platform_version = data['id']
+        @can_disable_images = data['canDisableImages']
+        @status = data['status']
+      end
+
+      # @return [String] Unique identifier for the email preview.
+      attr_accessor :id
+
+      # @return [String] The display name of the email client.
+      attr_accessor :name
+
+      # @return [String] Whether the platform is desktop, mobile, or web-based.
+      attr_accessor :platform_group
+
+      # @return [String] The type of platform on which the email client is running.
+      attr_accessor :platform_type
+
+      # @return [String] The platform version number.
+      attr_accessor :platform_version
+
+      # @return [Boolean] If true, images can be disabled when generating previews.
+      attr_accessor :can_disable_images
+
+      # @return [String] The current status of the email client.
+      attr_accessor :status
+    end
+  end
+end

data/lib/Mailosaur/models/preview_email_client_list_result.rb

@@ -0,0 +1,14 @@
+module Mailosaur
+  module Models
+    class PreviewEmailClientListResult < BaseModel
+      def initialize(data = {})
+        @items = []
+        (data['items'] || []).each { |i| @items << Mailosaur::Models::PreviewEmailClient.new(i) }
+      end
+
+      # @return [Array<PreviewEmailClient>] A list of available email clients with which to generate email previews.
+      # A list of available email clients.
+      attr_accessor :items
+    end
+  end
+end

data/lib/Mailosaur/models/preview_list_result.rb

@@ -0,0 +1,14 @@
+module Mailosaur
+  module Models
+    class PreviewListResult < BaseModel
+      def initialize(data = {})
+        @items = []
+        (data['items'] || []).each { |i| @items << Mailosaur::Models::Preview.new(i) }
+      end
+
+      # @return [Array<Preview>] A list of requested email previews.
+      # The summaries for each requested preview.
+      attr_accessor :items
+    end
+  end
+end

data/lib/Mailosaur/models/preview_request.rb

@@ -0,0 +1,16 @@
+module Mailosaur
+  module Models
+    class PreviewRequest < BaseModel
+      def initialize(email_client, disable_images: false)
+        @email_client = email_client
+        @disable_images = disable_images
+      end
+
+      # @return [String] The email client the preview was generated with.
+      attr_accessor :email_client
+
+      # @return [Boolean] True if images were disabled in the preview.
+      attr_accessor :disable_images
+    end
+  end
+end

data/lib/Mailosaur/models/preview_request_options.rb

@@ -0,0 +1,12 @@
+module Mailosaur
+  module Models
+    class PreviewRequestOptions < BaseModel
+      def initialize(previews)
+        @previews = previews
+      end
+
+      # @return [PreviewRequest] The list of email preview requests.
+      attr_accessor :previews
+    end
+  end
+end

data/lib/Mailosaur/previews.rb

@@ -0,0 +1,29 @@
+module Mailosaur
+  class Previews
+    #
+    # Creates and initializes a new instance of the Previews class.
+    # @param client connection.
+    #
+    def initialize(conn, handle_http_error)
+      @conn = conn
+      @handle_http_error = handle_http_error
+    end
+
+    # @return [Connection] the client connection.
+    attr_reader :conn
+
+    #
+    # List all email clients that can be used to generate email previews.
+    #
+    # Returns a list of available email clients.
+    #
+    # @return [PreviewEmailClientListResult] operation results.
+    #
+    def list_email_clients
+      response = conn.get 'api/previews/clients'
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.parse(response.body)
+      Mailosaur::Models::PreviewEmailClientListResult.new(model)
+    end
+  end
+end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '7.12.0'.freeze
+    VERSION = '7.13.0'.freeze
 end

data/lib/mailosaur.rb

@@ -15,6 +15,7 @@ module Mailosaur
   autoload :Servers,                                            'Mailosaur/servers.rb'
   autoload :Usage,                                              'Mailosaur/usage.rb'
   autoload :Devices,                                            'Mailosaur/devices.rb'
+  autoload :Previews,                                           'Mailosaur/previews.rb'
   autoload :MailosaurError,                                     'Mailosaur/mailosaur_error.rb'
 
   module Models
@@ -47,6 +48,12 @@ module Mailosaur
     autoload :DeviceListResult,                                   'Mailosaur/models/device_list_result.rb'
     autoload :DeviceCreateOptions,                                'Mailosaur/models/device_create_options.rb'
     autoload :OtpResult,                                          'Mailosaur/models/otp_result.rb'
+    autoload :Preview,                                            'Mailosaur/models/preview.rb'
+    autoload :PreviewEmailClient,                                 'Mailosaur/models/preview_email_client.rb'
+    autoload :PreviewEmailClientListResult,                       'Mailosaur/models/preview_email_client_list_result.rb'
+    autoload :PreviewListResult,                                  'Mailosaur/models/preview_list_result.rb'
+    autoload :PreviewRequest,                                     'Mailosaur/models/preview_request.rb'
+    autoload :PreviewRequestOptions,                              'Mailosaur/models/preview_request_options.rb'
     autoload :BaseModel,                                          'Mailosaur/models/base_model.rb'
   end
 
@@ -86,11 +93,16 @@ module Mailosaur
       @usage ||= Usage.new(connection, method(:handle_http_error))
     end
 
-    # @return [Devices] usage
+    # @return [Devices] devices
     def devices
       @devices ||= Devices.new(connection, method(:handle_http_error))
     end
 
+    # @return [Previews] previews
+    def previews
+      @previews ||= Previews.new(connection, method(:handle_http_error))
+    end
+
     private
 
     def connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 7.12.0
+  version: 7.13.0
 platform: ruby
 authors:
 - Mailosaur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2023-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -56,20 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.1
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.1
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +165,12 @@ files:
 - lib/Mailosaur/models/message_summary.rb
 - lib/Mailosaur/models/metadata.rb
 - lib/Mailosaur/models/otp_result.rb
+- lib/Mailosaur/models/preview.rb
+- lib/Mailosaur/models/preview_email_client.rb
+- lib/Mailosaur/models/preview_email_client_list_result.rb
+- lib/Mailosaur/models/preview_list_result.rb
+- lib/Mailosaur/models/preview_request.rb
+- lib/Mailosaur/models/preview_request_options.rb
 - lib/Mailosaur/models/search_criteria.rb
 - lib/Mailosaur/models/server.rb
 - lib/Mailosaur/models/server_create_options.rb
@@ -183,6 +183,7 @@ files:
 - lib/Mailosaur/models/usage_transaction.rb
 - lib/Mailosaur/models/usage_transaction_list_result.rb
 - lib/Mailosaur/module_definition.rb
+- lib/Mailosaur/previews.rb
 - lib/Mailosaur/servers.rb
 - lib/Mailosaur/usage.rb
 - lib/Mailosaur/version.rb
@@ -211,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: The Mailosaur Ruby library