unione 1.1.3

data/lib/unione/api/event_dump/event_dump_api.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module UniOne
+  module Api
+    module EventDump
+      # These methods are used to obtain a list of events for a given period of time. The data is stored for
+      # up to 45 days, depending on your tariff, i. e. you may fetch all event data starting from 00:00:00
+      # 31 days ago and up to current time. For custom tarifs with big sending volumes event dumps are
+      # available only for the last 7 days.
+      class EventDumpApi
+        # @param client [::UniOne::Client::ApiClient]
+        def initialize(client)
+          @client = client
+        end
+
+        # This asynchronous method initiates the preparation of data dump in CSV format. The number of dump
+        # files created or stored is limited to 10; to order more files, you have to delete one of the
+        # previous ones or wait until they will be deleted automatically. A newly created dump file is kept
+        # for 8 hours. If the request period is more than a day or there are too many events then several
+        # files will be generated and each file will contain no more than 100,000 events. File contains
+        # columns with the following information - 'event_time', 'job_id', 'from_email', 'email', 'status',
+        # 'delivery_status', 'metadata', 'destination_response', 'user_agent', 'url', 'ip', 'tags' and
+        # 'project_id' (for accounts with projects enabled). You can change the fields and include 'subject'
+        # field using 'dump_fileds' parameter.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#event-dump-create
+        # @param request [::UniOne::Api::EventDump::Model::EventDumpCreateRequest, Hash]
+        # @return [::UniOne::Api::EventDump::Model::EventDumpCreateResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def create(request)
+          ::UniOne::Api::EventDump::Model::EventDumpCreateResponse.from_h(@client.call('/event-dump/create.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Returns dump properties for a given identifier
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#event-dump-get
+        # @param request [::UniOne::Api::EventDump::Model::EventDumpGetRequest, Hash]
+        # @return [::UniOne::Api::EventDump::Model::EventDumpGetResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def get(request)
+          ::UniOne::Api::EventDump::Model::EventDumpGetResponse.from_h(@client.call('/event-dump/get.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # This method does not require any parameters; returns the full list of existing dumps.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#event-dump-list
+        # @return [::UniOne::Api::EventDump::Model::EventDumpListResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def list
+          ::UniOne::Api::EventDump::Model::EventDumpListResponse.from_h(@client.call('/event-dump/list.json'))
+        end
+
+        # Removes dump from queue or storage.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#event-dump-delete
+        # @param request [::UniOne::Api::EventDump::Model::EventDumpDeleteRequest, Hash]
+        # @return [::UniOne::Common::Model::SuccessResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def delete(request)
+          ::UniOne::Common::Model::SuccessResponse.from_h(@client.call('/event-dump/delete.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/event_dump/model/event_dump_create_request.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module EventDump
+      module Model
+        # EventDumpCreateRequest
+        class EventDumpCreateRequest
+          # Date and time in YYYY-MM-DD hh:mm:ss format, specifying period start time. Data is stored for up to
+          # 32 days, depending on your tariff.
+          # @return [String, nil]
+          attr_accessor :start_time
+
+          # Date and time in YYYY-MM-DD hh:mm:ss format, specifying period end time (non-inclusive).
+          # @return [String, nil]
+          attr_accessor :end_time
+
+          # Maximum number of events returned (default is 50). If this value is over 100 000, several files will
+          # be created, each having 100 000 events maximum.
+          # @return [Integer, nil]
+          attr_accessor :limit
+
+          # For accounts with projects enabled, the value all_projects=true allows to fetch data for all
+          # existing projects.
+          # Default: `False`.
+          # @return [Boolean, nil]
+          attr_accessor :all_projects
+
+          # An object with the properties of the event dump filter.
+          # @return [FilterObject, nil]
+          attr_accessor :filter
+
+          # An array of strings containing the names of columns you need in your report, in your preferred
+          # order. If the 'dump_fields' array is missing or empty, a default field list and order will be
+          # applied. Allowed values, in their default order, are - 'project_id', 'event_time', 'job_id',
+          # 'from_email', 'email', 'status', 'delivery_status', 'metadata', 'destination_response',
+          # 'user_agent', 'url', 'ip', 'tags'. For maximum security, the 'subject' field is not included by
+          # default, but you can add it by explicitly including in the 'dump_fields' array.
+          # @return [Array<String>, nil]
+          attr_accessor :dump_fields
+
+          # Allows you to obtain aggregated statistics for a given time period. The two allowed values are:
+          #
+          # - __day_status__ - fetch aggregated statistics (the filter value must be missing or empty, as filters are not allowed with this option);
+          # - __an empty string__ - used by default, event_dump/create works as if the aggregate parameter is omitted.
+          # @return [String, nil]
+          attr_accessor :aggregate
+
+          # Field delimiter, can be set to either  ',' or ';', defaults to  ','.
+          # @return [String, nil]
+          attr_accessor :delimiter
+
+          # File format, either “csv” (default) or “csv_gzip”.
+          # Default: `csv`.
+          # @return [String, nil]
+          attr_accessor :format
+
+          def initialize(
+            start_time:,
+            end_time: nil,
+            limit: nil,
+            all_projects: nil,
+            filter: nil,
+            dump_fields: nil,
+            aggregate: nil,
+            delimiter: nil,
+            format: nil
+          )
+            @start_time = start_time
+            @end_time = end_time
+            @limit = limit
+            @all_projects = all_projects
+            @filter = filter
+            @dump_fields = dump_fields
+            @aggregate = aggregate
+            @delimiter = delimiter
+            @format = format
+          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(
+              start_time: data['start_time'],
+              end_time: data['end_time'],
+              limit: data['limit'],
+              all_projects: data['all_projects'],
+              filter: ::UniOne::Client::Decode.model(::UniOne::Api::EventDump::Model::FilterObject, data['filter']),
+              dump_fields: ::UniOne::Client::Decode.list(data['dump_fields']),
+              aggregate: data['aggregate'],
+              delimiter: data['delimiter'],
+              format: data['format']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'start_time' => @start_time,
+              'end_time' => @end_time,
+              'limit' => @limit,
+              'all_projects' => @all_projects,
+              'filter' => @filter.nil? ? nil : @filter.to_h,
+              'dump_fields' => @dump_fields,
+              'aggregate' => @aggregate,
+              'delimiter' => @delimiter,
+              'format' => @format,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/event_dump/model/event_dump_create_response.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module EventDump
+      module Model
+        # EventDumpCreateResponse
+        class EventDumpCreateResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Dump identifier, used to call the
+          # [event-dump/get](https://docs.unione.io/en/web-api-ref#event-dump-get) method.
+          # @return [String, nil]
+          attr_accessor :dump_id
+
+          def initialize(
+            status: nil,
+            dump_id: nil
+          )
+            @status = status
+            @dump_id = dump_id
+          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'],
+              dump_id: data['dump_id']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'dump_id' => @dump_id,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/event_dump/model/event_dump_delete_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module EventDump
+      module Model
+        # EventDumpDeleteRequest
+        class EventDumpDeleteRequest
+          # Dump identifier, obtained via the
+          # [event-dump/create](https://docs.unione.io/en/web-api-ref#event-dump-create) method.
+          # @return [String, nil]
+          attr_accessor :dump_id
+
+          def initialize(
+            dump_id:
+          )
+            @dump_id = dump_id
+          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(
+              dump_id: data['dump_id']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'dump_id' => @dump_id,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/event_dump/model/event_dump_files_object.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module EventDump
+      module Model
+        # An object with the properties of the event dump file.
+        class EventDumpFilesObject
+          # Use this unique URL to download the requested dump file (either .csv or .csv.gz, depending on your
+          # request).
+          # @return [String, nil]
+          attr_accessor :url
+
+          # File size.
+          # @return [Integer, nil]
+          attr_accessor :size
+
+          def initialize(
+            url: nil,
+            size: nil
+          )
+            @url = url
+            @size = size
+          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(
+              url: data['url'],
+              size: data['size']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'url' => @url,
+              'size' => @size,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/event_dump/model/event_dump_get_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module EventDump
+      module Model
+        # EventDumpGetRequest
+        class EventDumpGetRequest
+          # Dump identifier received by the method
+          # [event-dump/create](https://docs.unione.io/en/web-api-ref#event-dump-create).
+          # @return [String, nil]
+          attr_accessor :dump_id
+
+          def initialize(
+            dump_id:
+          )
+            @dump_id = dump_id
+          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(
+              dump_id: data['dump_id']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'dump_id' => @dump_id,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/event_dump/model/event_dump_get_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module EventDump
+      module Model
+        # EventDumpGetResponse
+        class EventDumpGetResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # An object with the properties of the event dump.
+          # @return [EventDumpObject, nil]
+          attr_accessor :event_dump
+
+          def initialize(
+            status: nil,
+            event_dump: nil
+          )
+            @status = status
+            @event_dump = event_dump
+          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'],
+              event_dump: ::UniOne::Client::Decode.model(::UniOne::Api::EventDump::Model::EventDumpObject, data['event_dump'])
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'event_dump' => @event_dump.nil? ? nil : @event_dump.to_h,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/event_dump/model/event_dump_list_response.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module EventDump
+      module Model
+        # EventDumpListResponse
+        class EventDumpListResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # An array of objects describing event dumps. Each object is similar to 'event_dump' object returned
+          # by the [event-dump/get](https://docs.unione.io/en/web-api-ref#event-dump-get) method.
+          # @return [Array<EventDumpObject>, nil]
+          attr_accessor :event_dumps
+
+          def initialize(
+            status: nil,
+            event_dumps: nil
+          )
+            @status = status
+            @event_dumps = event_dumps
+          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'],
+              event_dumps: ::UniOne::Client::Decode.list(data['event_dumps']) { |item0| ::UniOne::Client::Decode.model(::UniOne::Api::EventDump::Model::EventDumpObject, item0) }
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'event_dumps' => @event_dumps.nil? ? nil : @event_dumps.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/event_dump/model/event_dump_object.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module EventDump
+      module Model
+        # An object with the properties of the event dump.
+        class EventDumpObject
+          # Dump ID received by the method
+          # [event-dump/create](https://docs.unione.io/en/web-api-ref#event-dump-create).
+          # @return [String, nil]
+          attr_accessor :dump_id
+
+          # Task status, possible values are:
+          #
+          # - __queued__ - the task is in the queue, processing is not started yet;
+          # - __in_process__ - the request is being processed;
+          # - __ready__ - the task is finished, dump file is ready for download;
+          # - __failed__ -  processing failed due to an internal error.
+          # @return [String, nil]
+          attr_accessor :dump_status
+
+          # An array of objects, each representing a file, ready for download. You may start downloading
+          # everything listed in “files” even if "dump_status" is still "in_process". If there are no events,
+          # according to the specified parameters, an empty array will be returned.
+          # @return [Array<EventDumpFilesObject>, nil]
+          attr_accessor :files
+
+          def initialize(
+            dump_id: nil,
+            dump_status: nil,
+            files: nil
+          )
+            @dump_id = dump_id
+            @dump_status = dump_status
+            @files = files
+          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(
+              dump_id: data['dump_id'],
+              dump_status: data['dump_status'],
+              files: ::UniOne::Client::Decode.list(data['files']) { |item0| ::UniOne::Client::Decode.model(::UniOne::Api::EventDump::Model::EventDumpFilesObject, item0) }
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'dump_id' => @dump_id,
+              'dump_status' => @dump_status,
+              'files' => @files.nil? ? nil : @files.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/event_dump/model/filter_object.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module EventDump
+      module Model
+        # An object with the properties of the event dump filter.
+        class FilterObject
+          # Job identifier returned earlier by [email/send](https://docs.unione.io/en/web-api-ref#email-send)
+          # method.
+          # @return [String, nil]
+          attr_accessor :job_id
+
+          # 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.
+          # __opened__ — the message has been delivered and read.
+          # __clicked__ — the message has been delivered, read, and at least one of the links in email has been
+          # clicked.
+          # __unsubscribed__ — the message has been delivered to the recipient and read, but then the recipient
+          # unsubscribed.
+          # __subscribed__ — the message has been delivered to the recipient and read, but then the recipient
+          # unsubscribed and subscribed again.
+          # __soft_bounced__ — temporary delivery failure. UniOne will try to deliver the message during 48
+          # hours.
+          # __hard_bounced__ — failed to deliver the message, there will be no delivery attempts.
+          # __spam__ — the message has been delivered, but it was reported as spam by the recipient.
+          # @return [EmailStatus, nil]
+          attr_accessor :status
+
+          # UniOne internal detailed delivery status, you can pass several values at once, comma-separated. Some
+          # possible values are:
+          #
+          # __err_user_unknown__ -- email address doesn't exist;
+          # __err_user_inactive__ -- email address isn't used anymore;
+          # __err_will_retry__ -- email was temporary rejected, delivery will be retried later;
+          # __err_mailbox_discarded__ -- email address was active earlier, but now it's deleted;
+          # __err_mailbox_full__ -- mailbox is full;
+          # __err_spam_rejected__ -- email was rejected as a spam;
+          # __err_blacklisted__ -- email was rejected because sender IP or sender domain is found in a black
+          # list;
+          # __err_too_large__ -- email size is over limit, according to recipient's server;
+          # __err_unsubscribed__ -- email was unsubscribed;
+          # __err_unreachable__ -- numerous delivery failures lead to mark this email address as permanently
+          # unavailable;
+          # __err_skip_letter__ -- sending has been canceled because the email address is temporarily
+          # unavailable;
+          # __err_domain_inactive__ -- the domain does not accept mail or does not exist;
+          # __err_destination_misconfigured__ -- the domain does not accept mail due to incorrect settings on
+          # the recipient’s side, and the server’s response contains information about a cause that can be fixed
+          # (for example, an inoperative blacklist is used, etc.);
+          # __err_delivery_failed__ -- delivery failed due to other reasons;
+          # __err_spam_skipped__ -- sending has been canceled because the campaign has been blocked as a spam;
+          # __err_lost__ -- the message was not sent due to inconsistency of its parts or it has been lost
+          # because of the failure on our side. The sender needs to re-send the letter on his own, since the
+          # original has not been saved;
+          #
+          # We reserve the right to change or add internal delivery statuses as we need, so the following list
+          # is provided as an example only, without any description: ok_sent, ok_delivered, ok_read,
+          # ok_link_visited, ok_unsubscribed, ok_resubscribed, ok_spam_folder, ok_fbl, not_sent,
+          # skip_dup_unreachable, skip_dup_temp_unreachable, skip_dup_mailbox_full, err_spam_removed,
+          # err_resend, err_unknown, err_retry_letter, err_src_invalid, err_dest_invalid, err_not_available,
+          # err_internal, err_no_dns, err_no_smtp, err_giveup.
+          # @return [String, nil]
+          attr_accessor :delivery_status
+
+          # Recipient email address
+          # @return [String, nil]
+          attr_accessor :email
+
+          # Sender email address
+          # @return [String, nil]
+          attr_accessor :email_from
+
+          # Recipient domain
+          # @return [String, nil]
+          attr_accessor :domain
+
+          # Campaign identifier, unsigned decimal integer or UUID up to 128-bit, passed in metadata with name
+          # "campaign_id" (name is configurable thru support).
+          # @return [String, nil]
+          attr_accessor :campaign_id
+
+          def initialize(
+            job_id: nil,
+            status: nil,
+            delivery_status: nil,
+            email: nil,
+            email_from: nil,
+            domain: nil,
+            campaign_id: nil
+          )
+            @job_id = job_id
+            @status = status
+            @delivery_status = delivery_status
+            @email = email
+            @email_from = email_from
+            @domain = domain
+            @campaign_id = campaign_id
+          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'],
+              status: data['status'],
+              delivery_status: data['delivery_status'],
+              email: data['email'],
+              email_from: data['email_from'],
+              domain: data['domain'],
+              campaign_id: data['campaign_id']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'job_id' => @job_id,
+              'status' => @status,
+              'delivery_status' => @delivery_status,
+              'email' => @email,
+              'email_from' => @email_from,
+              'domain' => @domain,
+              'campaign_id' => @campaign_id,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end