unione 1.1.3

data/lib/unione/api/template/template_api.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module UniOne
+  module Api
+    module Template
+      # You have the option of storing a template on the UniOne side and then using it by id, which is
+      # highly recommended for sending repetitive messages or high volume traffic. UniOne supports two
+      # different [template engines](https://docs.unione.io/en/template-engines).
+      class TemplateApi
+        # @param client [::UniOne::Client::ApiClient]
+        def initialize(client)
+          @client = client
+        end
+
+        # Creates or updates an email template.
+        #
+        # Restrictions:
+        # * The maximum request size is 10 MB.
+        # * The number of templates is limited to 10000.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#template-set
+        # @param request [::UniOne::Api::Template::Model::TemplateSetRequest, Hash]
+        # @return [::UniOne::Api::Template::Model::TemplateSetResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def set(request)
+          ::UniOne::Api::Template::Model::TemplateSetResponse.from_h(@client.call('/template/set.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Gets template properties by it's id.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#template-get
+        # @param request [::UniOne::Api::Template::Model::TemplateGetRequest, Hash]
+        # @return [::UniOne::Api::Template::Model::TemplateGetResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def get(request)
+          ::UniOne::Api::Template::Model::TemplateGetResponse.from_h(@client.call('/template/get.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Returns the list of all or some templates of the account.
+        #
+        # You can iterate thru large list using "offset" and "limit" parameters. When less than "limit"
+        # templates are returned then the end of list is reached.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#template-list
+        # @param request [::UniOne::Api::Template::Model::TemplateListRequest, Hash]
+        # @return [::UniOne::Api::Template::Model::TemplateListResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def list(request)
+          ::UniOne::Api::Template::Model::TemplateListResponse.from_h(@client.call('/template/list.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Deletes a template by id.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#template-delete
+        # @param request [::UniOne::Api::Template::Model::TemplateDeleteRequest, Hash]
+        # @return [::UniOne::Common::Model::SuccessResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def delete(request)
+          ::UniOne::Common::Model::SuccessResponse.from_h(@client.call('/template/delete.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/webhook/model/block_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Webhook
+      module Model
+        # Spam block type, either single or multiple sending SMTP. For single sending SMTP block in common
+        # pool UniOne retries several other SMTPs. This property exists only if
+        # event_name="transactional_spam_block".
+        module BlockType
+          ONE_SMTP = 'one_smtp'
+          ALL_SMTP = 'all_smtp'
+
+          # All values
+          ALL = [ONE_SMTP, ALL_SMTP].freeze
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/webhook/model/device_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Webhook
+      module Model
+        # Recipient's device type, detected from the user agent. Present for "clicked" and "opened" statuses;
+        # equals "unknown" if the device type couldn't be detected.
+        module DeviceType
+          DESKTOP = 'desktop'
+          MOBILE = 'mobile'
+          TABLET = 'tablet'
+          OTHER = 'other'
+          UNKNOWN = 'unknown'
+
+          # All values
+          ALL = [DESKTOP, MOBILE, TABLET, OTHER, UNKNOWN].freeze
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/webhook/model/domain_status.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Webhook
+      module Model
+        # Whether it's a block or unblock event. This property exists only if
+        # event_name="transactional_spam_block".
+        module DomainStatus
+          BLOCKED = 'blocked'
+          UNBLOCKED = 'unblocked'
+
+          # All values
+          ALL = [BLOCKED, UNBLOCKED].freeze
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/webhook/model/event_name.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Webhook
+      module Model
+        # Type of event data contained in event_data field, either "transactional_email_status" or
+        # "transactional_spam_block".
+        module EventName
+          TRANSACTIONAL_EMAIL_STATUS = 'transactional_email_status'
+          TRANSACTIONAL_SPAM_BLOCK = 'transactional_spam_block'
+
+          # All values
+          ALL = [TRANSACTIONAL_EMAIL_STATUS, TRANSACTIONAL_SPAM_BLOCK].freeze
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/webhook/model/traffic_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Webhook
+      module Model
+        # Traffic quality for "opened" and "clicked" statuses. "human" means a recognized browser or email
+        # client without machine signs; "machine" means a bot, link scanner or security proxy; "protected"
+        # means a mailbox/OS privacy proxy where a human action cannot be confirmed (Apple Mail Privacy
+        # Protection / iCloud Private Relay, Gmail Image Proxy — Apple MPP is protected, not machine);
+        # "unknown" means the user agent is missing, broken or not recognized.
+        module TrafficType
+          HUMAN = 'human'
+          MACHINE = 'machine'
+          PROTECTED = 'protected'
+          UNKNOWN = 'unknown'
+
+          # All values
+          ALL = [HUMAN, MACHINE, PROTECTED, UNKNOWN].freeze
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/webhook/model/webhook_callback.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Webhook
+      module Model
+        # Webhook callback format description.
+        class WebhookCallback
+          # MD5-hash of the message body, in which the value "auth" is replaced by api key of the user/project;
+          # with this field the recipient of the notification can both authenticate and verify the notification
+          # integrity
+          # @return [String, nil]
+          attr_accessor :auth
+
+          # Array with only one element, containing events of a user/project.
+          # @return [Array<WebhookCallbackEventsByUserItem>, nil]
+          attr_accessor :events_by_user
+
+          def initialize(
+            auth: nil,
+            events_by_user: nil
+          )
+            @auth = auth
+            @events_by_user = events_by_user
+          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(
+              auth: data['auth'],
+              events_by_user: ::UniOne::Client::Decode.list(data['events_by_user']) { |item0| ::UniOne::Client::Decode.model(::UniOne::Api::Webhook::Model::WebhookCallbackEventsByUserItem, item0) }
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'auth' => @auth,
+              'events_by_user' => @events_by_user.nil? ? nil : @events_by_user.map { |item0| item0.to_h },
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/webhook/model/webhook_callback_events_by_user_item.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Webhook
+      module Model
+        # WebhookCallbackEventsByUserItem
+        class WebhookCallbackEventsByUserItem
+          # Unique user identifier.
+          # @return [Integer, nil]
+          attr_accessor :user_id
+
+          # Project identifier, present only if webhook was registered for the project using project API key.
+          # @return [String, nil]
+          attr_accessor :project_id
+
+          # Project name, present only if webhook was registered for the project using project API key.
+          # @return [String, nil]
+          attr_accessor :project_name
+
+          # Array of events reported by webhook.
+          # @return [Array<WebhookCallbackEventsByUserItemEventsItem>, nil]
+          attr_accessor :events
+
+          def initialize(
+            user_id: nil,
+            project_id: nil,
+            project_name: nil,
+            events: nil
+          )
+            @user_id = user_id
+            @project_id = project_id
+            @project_name = project_name
+            @events = events
+          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(
+              user_id: data['user_id'],
+              project_id: data['project_id'],
+              project_name: data['project_name'],
+              events: ::UniOne::Client::Decode.list(data['events']) { |item0| ::UniOne::Client::Decode.model(::UniOne::Api::Webhook::Model::WebhookCallbackEventsByUserItemEventsItem, item0) }
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'user_id' => @user_id,
+              'project_id' => @project_id,
+              'project_name' => @project_name,
+              'events' => @events.nil? ? nil : @events.map { |item0| item0.to_h },
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/webhook/model/webhook_callback_events_by_user_item_events_item.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Webhook
+      module Model
+        # WebhookCallbackEventsByUserItemEventsItem
+        class WebhookCallbackEventsByUserItemEventsItem
+          # Type of event data contained in event_data field, either "transactional_email_status" or
+          # "transactional_spam_block".
+          # @return [EventName, nil]
+          attr_accessor :event_name
+
+          # Object with different event properties depending on "event_name". Below you can see all the
+          # properties, "transactional_email_status"-related first and then "transactional_spam_block"-related.
+          # @return [WebhookCallbackEventsByUserItemEventsItemEventData, nil]
+          attr_accessor :event_data
+
+          def initialize(
+            event_name: nil,
+            event_data: nil
+          )
+            @event_name = event_name
+            @event_data = event_data
+          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(
+              event_name: data['event_name'],
+              event_data: ::UniOne::Client::Decode.model(::UniOne::Api::Webhook::Model::WebhookCallbackEventsByUserItemEventsItemEventData, data['event_data'])
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'event_name' => @event_name,
+              'event_data' => @event_data.nil? ? nil : @event_data.to_h,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/webhook/model/webhook_callback_events_by_user_item_events_item_event_data.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Webhook
+      module Model
+        # Object with different event properties depending on "event_name". Below you can see all the
+        # properties, "transactional_email_status"-related first and then "transactional_spam_block"-related.
+        class WebhookCallbackEventsByUserItemEventsItemEventData
+          # Job identifier returned earlier by [email/send](https://docs.unione.io/en/web-api-ref#email-send)
+          # method. Property exists only if event_name="transactional_email_status".
+          # @return [String, nil]
+          attr_accessor :job_id
+
+          # Metadata passed in [email/send](https://docs.unione.io/en/web-api-ref#email-send) method in
+          # recipients.metadata or global_metadata properties. This property exists only if
+          # event_name="transactional_email_status".
+          # @return [Hash{String => String}, nil]
+          attr_accessor :metadata
+
+          # Recipient's email. This property exists only if event_name="transactional_email_status".
+          # @return [String, nil]
+          attr_accessor :email
+
+          # Email delivery status. This property exists only if event_name="transactional_email_status".
+          # Possible values are:
+          #
+          # __accepted__ — the message has been accepted, but not sent yet.
+          # __sent__ — the message has been sent, but not delivered yet.
+          # __delivered__ — the message has been delivered. It can be changed to “opened”, “clicked”,
+          # “unsubscribed”, “subscribed” or “spam”.
+          # __opened__ — the message has been delivered and read. It can be changed to “clicked”,
+          # “unsubscribed”, “subscribed” or “spam”.
+          # __clicked__ — the message has been delivered, read, and at least one of the links in email has been
+          # clicked. It can be changed to “unsubscribed”, “subscribed” or “spam”.
+          # __unsubscribed__ — the message has been delivered to the recipient and read, but then the recipient
+          # unsubscribed. It can be changed to “subscribed”.
+          # __subscribed__ — the message has been delivered to the recipient and read, but then the recipient
+          # unsubscribed and subscribed again. It can be changed to “unsubscribed”.
+          # __soft_bounced__ — temporary delivery failure. UniOne will try to deliver the message during 48
+          # hours. In case of success the status changes to “delivered”, in case of failure to deliver during 48
+          # hours message status changes to “hard_bounced”.
+          # __hard_bounced__ — failed to deliver the message, there will be no delivery attempts. It's a final
+          # status. There are a lot of possible reasons, you can use SMTP response from
+          # delivery_info.destination_response field or UniOne internal reason classification from
+          # delivery_info.delivery_status field to analyze the reason.
+          # __spam__ — the message has been delivered, but it was reported as spam by the recipient. UniOne can
+          # receive and process the spam complaint from several domains, including msn.com, outlook.com,
+          # hotmail.com, live.com, ukr.net, yahoo.com, aol.com using
+          # [FBL](https://en.wikipedia.org/wiki/Feedback_loop_(email)).
+          # @return [EmailStatus, nil]
+          attr_accessor :status
+
+          # Event date & time in UTC time zone in "YYYY-MM-DD hh:mm:ss" format. This property exists only if
+          # event_name="transactional_email_status".
+          # @return [String, nil]
+          attr_accessor :event_time
+
+          # URL for "opened" and "clicked" statuses. This property exists only if
+          # event_name="transactional_email_status".
+          # @return [String, nil]
+          attr_accessor :url
+
+          # Object with detailed delivery info.Event date & time in UTC time zone in "YYYY-MM-DD hh:mm:ss"
+          # format. This property exists only if webhook has delivery_info proeprty set to 1 and
+          # event_name="transactional_email_status".
+          # @return [WebhookCallbackEventsByUserItemEventsItemEventDataDeliveryInfo, nil]
+          attr_accessor :delivery_info
+
+          # Spam block date & time in UTC time zone in "YYYY-MM-DD hh:mm:ss" format. This property exists only
+          # if event_name="transactional_spam_block".
+          # @return [String, nil]
+          attr_accessor :block_time
+
+          # Spam block type, either single or multiple sending SMTP. For single sending SMTP block in common
+          # pool UniOne retries several other SMTPs. This property exists only if
+          # event_name="transactional_spam_block".
+          # @return [BlockType, nil]
+          attr_accessor :block_type
+
+          # Domain that blocked sending. This property exists only if event_name="transactional_spam_block".
+          # @return [String, nil]
+          attr_accessor :domain
+
+          # Number of sending SMTPs blocked. This property exists only if event_name="transactional_spam_block".
+          # @return [Integer, nil]
+          attr_accessor :smtp_blocks_count
+
+          # Whether it's a block or unblock event. This property exists only if
+          # event_name="transactional_spam_block".
+          # @return [DomainStatus, nil]
+          attr_accessor :domain_status
+
+          def initialize(
+            job_id: nil,
+            metadata: nil,
+            email: nil,
+            status: nil,
+            event_time: nil,
+            url: nil,
+            delivery_info: nil,
+            block_time: nil,
+            block_type: nil,
+            domain: nil,
+            smtp_blocks_count: nil,
+            domain_status: nil
+          )
+            @job_id = job_id
+            @metadata = metadata
+            @email = email
+            @status = status
+            @event_time = event_time
+            @url = url
+            @delivery_info = delivery_info
+            @block_time = block_time
+            @block_type = block_type
+            @domain = domain
+            @smtp_blocks_count = smtp_blocks_count
+            @domain_status = domain_status
+          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(
+              job_id: data['job_id'],
+              metadata: ::UniOne::Client::Decode.map(data['metadata']),
+              email: data['email'],
+              status: data['status'],
+              event_time: data['event_time'],
+              url: data['url'],
+              delivery_info: ::UniOne::Client::Decode.model(::UniOne::Api::Webhook::Model::WebhookCallbackEventsByUserItemEventsItemEventDataDeliveryInfo, data['delivery_info']),
+              block_time: data['block_time'],
+              block_type: data['block_type'],
+              domain: data['domain'],
+              smtp_blocks_count: data['SMTP_blocks_count'],
+              domain_status: data['domain_status']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'job_id' => @job_id,
+              'metadata' => @metadata,
+              'email' => @email,
+              'status' => @status,
+              'event_time' => @event_time,
+              'url' => @url,
+              'delivery_info' => @delivery_info.nil? ? nil : @delivery_info.to_h,
+              'block_time' => @block_time,
+              'block_type' => @block_type,
+              'domain' => @domain,
+              'SMTP_blocks_count' => @smtp_blocks_count,
+              'domain_status' => @domain_status,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end