unione 1.1.3

data/lib/unione/api/suppression/model/suppression_delete_request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Suppression
+      module Model
+        # SuppressionDeleteRequest
+        class SuppressionDeleteRequest
+          # An email to delete from suppression list.
+          # @return [String, nil]
+          attr_accessor :email
+
+          def initialize(
+            email:
+          )
+            @email = 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(
+              email: data['email']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'email' => @email,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/suppression/model/suppression_get_object.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Suppression
+      module Model
+        # Object with suppression details.
+        class SuppressionGetObject
+          # Unqiue project identifier, ASCII string up to 36 characters long.
+          # @return [String, nil]
+          attr_accessor :project_id
+
+          # Cause of email being suppressed. One of:
+          #
+          # - __unsubscribed__ - email is unsubscribed;
+          # - __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 due to multiple hard bounces;
+          # - __complained__ -  the recipient reported spam in the previous emails;
+          # - __blocked__ -  sending to the email is prohibited by administration of UniOne.
+          # We may add some new causes in the future.
+          # @return [String, nil]
+          attr_accessor :cause
+
+          # Source of email being suppressed. One of:
+          #
+          # - __user__ - suppressed by user with    [suppression/set](https://docs.unione.io/en/web-api-ref#suppression-set);
+          # - __system__ - sending to the email is prohibited by system, for example due to multiple hard bounces;
+          # - __subscriber__ - the recipient reported spam or unsubscribed in the previous emails.
+          # @return [String, nil]
+          attr_accessor :source
+
+          # Is it possible to delete this suppression by calling suppression/delete method.
+          # @return [Boolean, nil]
+          attr_accessor :is_deletable
+
+          # When suppression was created, in UTC timezone in "YYYY-MM-DD hh:mm:ss" format.
+          # @return [String, nil]
+          attr_accessor :created
+
+          def initialize(
+            project_id: nil,
+            cause: nil,
+            source: nil,
+            is_deletable: nil,
+            created: nil
+          )
+            @project_id = project_id
+            @cause = cause
+            @source = source
+            @is_deletable = is_deletable
+            @created = created
+          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(
+              project_id: data['project_id'],
+              cause: data['cause'],
+              source: data['source'],
+              is_deletable: data['is_deletable'],
+              created: data['created']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'project_id' => @project_id,
+              'cause' => @cause,
+              'source' => @source,
+              'is_deletable' => @is_deletable,
+              'created' => @created,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/suppression/model/suppression_get_request.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Suppression
+      module Model
+        # SuppressionGetRequest
+        class SuppressionGetRequest
+          # Email to get suppression details for.
+          # @return [String, nil]
+          attr_accessor :email
+
+          # If a user has projects functionality enabled, he/she can pass all_projects=true to search in all
+          # projects' data.
+          # Default: `False`.
+          # @return [Boolean, nil]
+          attr_accessor :all_projects
+
+          def initialize(
+            email:,
+            all_projects: nil
+          )
+            @email = email
+            @all_projects = all_projects
+          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(
+              email: data['email'],
+              all_projects: data['all_projects']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'email' => @email,
+              'all_projects' => @all_projects,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/suppression/model/suppression_get_response.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Suppression
+      module Model
+        # SuppressionGetResponse
+        class SuppressionGetResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # The email for which suppression details were requested.
+          # @return [String, nil]
+          attr_accessor :email
+
+          # Array of suppression objects.
+          # @return [Array<SuppressionGetObject>, nil]
+          attr_accessor :suppressions
+
+          def initialize(
+            status: nil,
+            email: nil,
+            suppressions: nil
+          )
+            @status = status
+            @email = email
+            @suppressions = suppressions
+          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'],
+              email: data['email'],
+              suppressions: ::UniOne::Client::Decode.list(data['suppressions']) { |item0| ::UniOne::Client::Decode.model(::UniOne::Api::Suppression::Model::SuppressionGetObject, item0) }
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'email' => @email,
+              'suppressions' => @suppressions.nil? ? nil : @suppressions.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/suppression/model/suppression_list_object.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Suppression
+      module Model
+        # Object with suppression details.
+        class SuppressionListObject
+          # Email to get suppression details for.
+          # @return [String, nil]
+          attr_accessor :email
+
+          # Cause of email being suppressed. One of:
+          #
+          # - __unsubscribed__ - email is unsubscribed;
+          # - __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 due to multiple hard bounces;
+          # - __complained__ -  the recipient reported spam in the previous emails;
+          # - __blocked__ -  sending to the email is prohibited by administration of UniOne.
+          # We may add some new causes in the future.
+          # @return [String, nil]
+          attr_accessor :cause
+
+          # Source of email being suppressed. One of:
+          #
+          # - __user__ - suppressed by user with    [suppression/set](https://docs.unione.io/en/web-api-ref#suppression-set);
+          # - __system__ - sending to the email is prohibited by system, for example due to multiple hard bounces;
+          # - __subscriber__ - the recipient reported spam or unsubscribed in the previous emails.
+          # @return [String, nil]
+          attr_accessor :source
+
+          # Is it possible to delete this suppression by calling suppression/delete method.
+          # @return [Boolean, nil]
+          attr_accessor :is_deletable
+
+          # When suppression was created, in UTC timezone in "YYYY-MM-DD hh:mm:ss" format.
+          # @return [String, nil]
+          attr_accessor :created
+
+          def initialize(
+            email: nil,
+            cause: nil,
+            source: nil,
+            is_deletable: nil,
+            created: nil
+          )
+            @email = email
+            @cause = cause
+            @source = source
+            @is_deletable = is_deletable
+            @created = created
+          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(
+              email: data['email'],
+              cause: data['cause'],
+              source: data['source'],
+              is_deletable: data['is_deletable'],
+              created: data['created']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'email' => @email,
+              'cause' => @cause,
+              'source' => @source,
+              'is_deletable' => @is_deletable,
+              'created' => @created,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/suppression/model/suppression_list_request.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Suppression
+      module Model
+        # SuppressionListRequest
+        class SuppressionListRequest
+          # Cause of email being suppressed. One of:
+          #
+          # - __unsubscribed__ - email is unsubscribed;
+          # - __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 due to multiple hard bounces;
+          # - __complained__ -  the recipient reported spam in the previous emails;
+          # - __blocked__ -  sending to the email is prohibited by administration of UniOne.
+          # We may add some new causes in the future.
+          # @return [String, nil]
+          attr_accessor :cause
+
+          # Source of email being suppressed. One of:
+          #
+          # - __user__ - suppressed by user with    [suppression/set](https://docs.unione.io/en/web-api-ref#suppression-set);
+          # - __system__ - sending to the email is prohibited by system, for example due to multiple hard bounces;
+          # - __subscriber__ - the recipient reported spam or unsubscribed in the previous emails.
+          # @return [String, nil]
+          attr_accessor :source
+
+          # Date in the format YYYY-MM-DD hh:mm:ss to get suppression list from the "start_time" to the present
+          # day. Ignored if "cursor" is not empty.
+          # @return [String, nil]
+          attr_accessor :start_time
+
+          # The parameter indicates from which position the selection is to be started. Must be empty or omitted
+          # for the first data chunk. In order to get subsequent chunks, you must set the "cursor" parameter in
+          # your request, using the value received in response to the previous request.
+          # @return [String, nil]
+          attr_accessor :cursor
+
+          # Limits the number of records to be returned at one time, default is 50.
+          # @return [Integer, nil]
+          attr_accessor :limit
+
+          def initialize(
+            cause: nil,
+            source: nil,
+            start_time: nil,
+            cursor: nil,
+            limit: nil
+          )
+            @cause = cause
+            @source = source
+            @start_time = start_time
+            @cursor = cursor
+            @limit = limit
+          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(
+              cause: data['cause'],
+              source: data['source'],
+              start_time: data['start_time'],
+              cursor: data['cursor'],
+              limit: data['limit']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'cause' => @cause,
+              'source' => @source,
+              'start_time' => @start_time,
+              'cursor' => @cursor,
+              'limit' => @limit,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/suppression/model/suppression_list_response.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Suppression
+      module Model
+        # SuppressionListResponse
+        class SuppressionListResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Array of suppression objects.
+          # @return [Array<SuppressionListObject>, nil]
+          attr_accessor :suppressions
+
+          # The parameter indicates from which position the selection is to be started. Must be empty or omitted
+          # for the first data chunk. In order to get subsequent chunks, you must set the "cursor" parameter in
+          # your request, using the value received in response to the previous request.
+          # @return [String, nil]
+          attr_accessor :cursor
+
+          def initialize(
+            status: nil,
+            suppressions: nil,
+            cursor: nil
+          )
+            @status = status
+            @suppressions = suppressions
+            @cursor = cursor
+          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'],
+              suppressions: ::UniOne::Client::Decode.list(data['suppressions']) { |item0| ::UniOne::Client::Decode.model(::UniOne::Api::Suppression::Model::SuppressionListObject, item0) },
+              cursor: data['cursor']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'suppressions' => @suppressions.nil? ? nil : @suppressions.map { |item0| item0.to_h },
+              'cursor' => @cursor,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/suppression/model/suppression_set_request.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Suppression
+      module Model
+        # SuppressionSetRequest
+        class SuppressionSetRequest
+          # Email to add in suppression list.
+          # @return [String, nil]
+          attr_accessor :email
+
+          # Cause of email being suppressed. One of:
+          #
+          # - __unsubscribed__ - email is unsubscribed;
+          # - __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 due to multiple hard bounces;
+          # - __complained__ -  the recipient reported spam in the previous emails;
+          # @return [String, nil]
+          attr_accessor :cause
+
+          # When suppression was created, in UTC timezone in "YYYY-MM-DD hh:mm:ss" format.
+          # @return [String, nil]
+          attr_accessor :created
+
+          def initialize(
+            email:,
+            cause:,
+            created: nil
+          )
+            @email = email
+            @cause = cause
+            @created = created
+          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(
+              email: data['email'],
+              cause: data['cause'],
+              created: data['created']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'email' => @email,
+              'cause' => @cause,
+              'created' => @created,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/suppression/suppression_api.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module UniOne
+  module Api
+    module Suppression
+      # Methods for managing suppression lists. An email can be added to suppression list because of
+      # unsubscription, bounce or complain.
+      class SuppressionApi
+        # @param client [::UniOne::Client::ApiClient]
+        def initialize(client)
+          @client = client
+        end
+
+        # Adds an email address to the suppression list. You can always remove this address from the
+        # suppression list later using the
+        # [suppression/delete](https://docs.unione.io/en/web-api-ref#suppression-delete) method.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#suppression-set
+        # @param request [::UniOne::Api::Suppression::Model::SuppressionSetRequest, Hash]
+        # @return [::UniOne::Common::Model::SuccessResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def set(request)
+          ::UniOne::Common::Model::SuccessResponse.from_h(@client.call('/suppression/set.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Gets a reason and date of email suppression.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#suppression-get
+        # @param request [::UniOne::Api::Suppression::Model::SuppressionGetRequest, Hash]
+        # @return [::UniOne::Api::Suppression::Model::SuppressionGetResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def get(request)
+          ::UniOne::Api::Suppression::Model::SuppressionGetResponse.from_h(@client.call('/suppression/get.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Returns a suppression list since provided date.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#suppression-list
+        # @param request [::UniOne::Api::Suppression::Model::SuppressionListRequest, Hash]
+        # @return [::UniOne::Api::Suppression::Model::SuppressionListResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def list(request)
+          ::UniOne::Api::Suppression::Model::SuppressionListResponse.from_h(@client.call('/suppression/list.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Deletes an email from suppression list (only records with is_deletable=true). If there are no
+        # entries of this email in the suppression list, API error 3003 is returned. If such entries exist but
+        # no one can be deleted, API error 3004 is returned. If daily limit of deletes exceeded, API error 906
+        # is returned.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#suppression-delete
+        # @param request [::UniOne::Api::Suppression::Model::SuppressionDeleteRequest, Hash]
+        # @return [::UniOne::Common::Model::SuccessResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def delete(request)
+          ::UniOne::Common::Model::SuccessResponse.from_h(@client.call('/suppression/delete.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/system/model/project_accounting_object.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module System
+      module Model
+        # Object with email counter properties. Present only if the API key used for request is the user API
+        # key.
+        class ProjectAccountingObject
+          # Project's email counter value. It increases on every email sent.
+          # @return [Integer, nil]
+          attr_accessor :email_counter
+
+          # Allows you to limit the number of emails sent by the project. The sending stops when the limit is
+          # reached. Any non-negative 64-bit integer is acceptable. 0 means no limit.
+          # @return [Integer, nil]
+          attr_accessor :email_counter_limit
+
+          # 'default' - the counter resets to zero automatically at the beginning of each accounting period.
+          # 'permanent' - the counter never resets automatically.
+          # Default: `default`.
+          # @return [EmailCounterMode, nil]
+          attr_accessor :email_counter_mode
+
+          def initialize(
+            email_counter: nil,
+            email_counter_limit: nil,
+            email_counter_mode: nil
+          )
+            @email_counter = email_counter
+            @email_counter_limit = email_counter_limit
+            @email_counter_mode = email_counter_mode
+          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(
+              email_counter: data['email_counter'],
+              email_counter_limit: data['email_counter_limit'],
+              email_counter_mode: data['email_counter_mode']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'email_counter' => @email_counter,
+              'email_counter_limit' => @email_counter_limit,
+              'email_counter_mode' => @email_counter_mode,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end