unione 1.1.3

data/lib/unione/api/domain/model/domain_validate_dkim_request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Domain
+      module Model
+        # DomainValidateDkimRequest
+        class DomainValidateDkimRequest
+          # Domain to validate DKIM record for.
+          # @return [String, nil]
+          attr_accessor :domain
+
+          def initialize(
+            domain:
+          )
+            @domain = domain
+          end
+
+          # Builds the object from decoded JSON. Lenient: a missing field, nil or a value of another type
+          # gives nil (data that is not a Hash gives an empty object).
+          def self.from_h(data)
+            data = {} unless data.is_a?(Hash)
+            new(
+              domain: data['domain']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'domain' => @domain,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/domain/model/domain_validate_dkim_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Domain
+      module Model
+        # DomainValidateDkimResponse
+        class DomainValidateDkimResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Debug message.
+          # @return [String, nil]
+          attr_accessor :message
+
+          def initialize(
+            status: nil,
+            message: nil
+          )
+            @status = status
+            @message = message
+          end
+
+          # Builds the object from decoded JSON. Lenient: a missing field, nil or a value of another type
+          # gives nil (data that is not a Hash gives an empty object).
+          def self.from_h(data)
+            data = {} unless data.is_a?(Hash)
+            new(
+              status: data['status'],
+              message: data['message']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'message' => @message,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/domain/model/domain_validate_verification_record_request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Domain
+      module Model
+        # DomainValidateVerificationRecordRequest
+        class DomainValidateVerificationRecordRequest
+          # Domain to validate verification record for.
+          # @return [String, nil]
+          attr_accessor :domain
+
+          def initialize(
+            domain:
+          )
+            @domain = domain
+          end
+
+          # Builds the object from decoded JSON. Lenient: a missing field, nil or a value of another type
+          # gives nil (data that is not a Hash gives an empty object).
+          def self.from_h(data)
+            data = {} unless data.is_a?(Hash)
+            new(
+              domain: data['domain']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'domain' => @domain,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/domain/model/domain_validate_verification_record_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Domain
+      module Model
+        # DomainValidateVerificationRecordResponse
+        class DomainValidateVerificationRecordResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Debug message.
+          # @return [String, nil]
+          attr_accessor :message
+
+          def initialize(
+            status: nil,
+            message: nil
+          )
+            @status = status
+            @message = message
+          end
+
+          # Builds the object from decoded JSON. Lenient: a missing field, nil or a value of another type
+          # gives nil (data that is not a Hash gives an empty object).
+          def self.from_h(data)
+            data = {} unless data.is_a?(Hash)
+            new(
+              status: data['status'],
+              message: data['message']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'message' => @message,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/email/email_api.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module UniOne
+  module Api
+    module Email
+      # This group of methods is related with email sending.
+      class EmailApi
+        # @param client [::UniOne::Client::ApiClient]
+        def initialize(client)
+          @client = client
+        end
+
+        # Sends an email or a bunch of emails
+        #
+        # While sending you can provide substitutions (merge tags), use a template, turn on read or click
+        # tracking, etc.
+        #
+        # Restrictions:
+        # * maximum request size is 10 MB
+        # * maximum number of recipients is 500
+        # * The symbol '/' is not allowed in attachment names
+        #
+        # If the list of recipients contains invalid, non-existent, duplicate, or unsubscribed emails, those
+        # emails will be returned in the output parameter failed_emails, and the email will be sent to all
+        # other valid emails addresses. If all the emails addresses fall into failed_emails, sending will not
+        # be carried out and API error 204 will be returned.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#email-send
+        # @param request [::UniOne::Api::Email::Model::EmailSendRequest, Hash]
+        # @return [::UniOne::Api::Email::Model::EmailSendResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def send_email(request)
+          ::UniOne::Api::Email::Model::EmailSendResponse.from_h(@client.call('/email/send.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Sends an email with (re)subscribe link.
+        #
+        # This method allows subscription renewal by a former subscriber who has previously unsubscribed, or
+        # who is blocked because of complaints. This method sends an email with a new subscription link to a
+        # former subscriber. Once the recipient clicks the link, their subscription status is restored.
+        # There is a default restriction that limits this method to being used once a day. If you need to
+        # resubscribe more often, please ask support about it.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#email-subscribe
+        # @param request [::UniOne::Api::Email::Model::EmailSubscribeRequest, Hash]
+        # @return [::UniOne::Common::Model::SuccessResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def subscribe(request)
+          ::UniOne::Common::Model::SuccessResponse.from_h(@client.call('/email/subscribe.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/email/model/email_send_request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Email
+      module Model
+        # EmailSendRequest
+        class EmailSendRequest
+          # Object containing all message properties.
+          # @return [MessageObject, nil]
+          attr_accessor :message
+
+          def initialize(
+            message:
+          )
+            @message = message
+          end
+
+          # Builds the object from decoded JSON. Lenient: a missing field, nil or a value of another type
+          # gives nil (data that is not a Hash gives an empty object).
+          def self.from_h(data)
+            data = {} unless data.is_a?(Hash)
+            new(
+              message: ::UniOne::Client::Decode.model(::UniOne::Api::Email::Model::MessageObject, data['message'])
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'message' => @message.nil? ? nil : @message.to_h,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/email/model/email_send_response.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Email
+      module Model
+        # EmailSendResponse
+        class EmailSendResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Job identifier, might be useful for investigating errors.
+          # @return [String, nil]
+          attr_accessor :job_id
+
+          # Array of recipients emails successfully accepted for sending.
+          # @return [Array<String>, nil]
+          attr_accessor :emails
+
+          # Object with emails rejected for sending as property names and their statuses as property values,
+          # e.g.: {"email1@gmail.com": "temporary_unavailable"}. Possible statuses:
+          #
+          # - __unsubscribed__ - specified email is unsubscribed;
+          # - __invalid__ - the email does not exist or has been entered incorrectly;
+          # - __duplicate__ - the email already exists in the request, email duplicating is prevented;
+          # - __temporary_unavailable__ - the email address is unavailable. This means that over the next three days sending to this address will return an error. Email may be temporarily unavailable due to several reasons, e.g.:
+          #
+          # - a previous email has been rejected by the recipient's server for spam;
+          # - the recipient's mailbox is full or is not used;
+          # - recipient's domain does not accept mail;
+          # - sending server was rejected due to blacklisting;
+          #
+          # - __permanent_unavailable__ - the email address is permanently unavailable or unsubscribed globally.
+          # - __complained__ -  the recipient reported spam in the previous emails;
+          # - __blocked__ -  sending to the email is prohibited by administration of UniOne.
+          # We may added new statuses in the future.
+          # @return [Hash{String => String}, nil]
+          attr_accessor :failed_emails
+
+          def initialize(
+            status: nil,
+            job_id: nil,
+            emails: nil,
+            failed_emails: nil
+          )
+            @status = status
+            @job_id = job_id
+            @emails = emails
+            @failed_emails = failed_emails
+          end
+
+          # Builds the object from decoded JSON. Lenient: a missing field, nil or a value of another type
+          # gives nil (data that is not a Hash gives an empty object).
+          def self.from_h(data)
+            data = {} unless data.is_a?(Hash)
+            new(
+              status: data['status'],
+              job_id: data['job_id'],
+              emails: ::UniOne::Client::Decode.list(data['emails']),
+              failed_emails: ::UniOne::Client::Decode.map(data['failed_emails'])
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'job_id' => @job_id,
+              'emails' => @emails,
+              'failed_emails' => @failed_emails,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/email/model/email_subscribe_request.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Email
+      module Model
+        # EmailSubscribeRequest
+        class EmailSubscribeRequest
+          # Sender’s email on a confirmed domain. (Field alias "email_address_from" is supported, too).
+          # @return [String, nil]
+          attr_accessor :from_email
+
+          # Sender’s name. (Field alias "name_from" is supported, too).
+          # @return [String, nil]
+          attr_accessor :from_name
+
+          # Recipient’s email. (Field alias "email_address_to" is supported, too).
+          # @return [String, nil]
+          attr_accessor :to_email
+
+          def initialize(
+            from_email:,
+            from_name:,
+            to_email:
+          )
+            @from_email = from_email
+            @from_name = from_name
+            @to_email = to_email
+          end
+
+          # Builds the object from decoded JSON. Lenient: a missing field, nil or a value of another type
+          # gives nil (data that is not a Hash gives an empty object).
+          def self.from_h(data)
+            data = {} unless data.is_a?(Hash)
+            new(
+              from_email: data['from_email'],
+              from_name: data['from_name'],
+              to_email: data['to_email']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'from_email' => @from_email,
+              'from_name' => @from_name,
+              'to_email' => @to_email,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end