unione 1.1.3

data/lib/unione/api/project/model/project_list_object.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Project
+      module Model
+        # ProjectListObject
+        class ProjectListObject
+          # Unqiue project identifier, ASCII string up to 36 characters long.
+          # @return [String, nil]
+          attr_accessor :id
+
+          # API key of the project. You can use it instead of the user API key parameter in all methods except
+          # project/* methods.
+          # @return [String, nil]
+          attr_accessor :api_key
+
+          # Project name, unique for user account.
+          # @return [String, nil]
+          attr_accessor :name
+
+          # ISO-3166 alpha-2 country code. If set, UniOne treats project personal data according to country
+          # laws, e.g. GDPR for european countries.
+          # @return [String, nil]
+          attr_accessor :country
+
+          # Date and time of project creation in UTC timezone in "YYYY-MM-DD hh:mm:ss" format.
+          # @return [String, nil]
+          attr_accessor :reg_time
+
+          # Whether email sending is enabled for this project or not.
+          # Default: `True`.
+          # @return [Boolean, nil]
+          attr_accessor :send_enabled
+
+          # If it's false then UniOne adds default unsubscribe footer to each email sent with API key of the
+          # project. If it's true then appending default unsubscribe footer for this project is avoided and
+          # sending with custom unsubscribe url or even without unsubscribe url is permitted for the project.
+          # Please note that custom_unsubscribe_url_enabled=true is available only if removing unsubscribe link
+          # is approved for the user account by support. More on this
+          # [here](https://docs.unione.io/en/unsubscribe-link). When custom_unsubscribe_url_enabled is skipped
+          # on creating a project, it's value is taken from user
+          # @return [Boolean, nil]
+          attr_accessor :custom_unsubscribe_url_enabled
+
+          # A unique domain identifier which will determine the [tracking
+          # domain](https://docs.unione.io/en/tracking-domains) or [dedicated IP](/dedicated-ip) pool to be used
+          # by default. If the value is not specified, a default backend domain will be assigned for your
+          # account or project instead.
+          # @return [Integer, nil]
+          attr_accessor :backend_domain_id
+
+          # 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
+
+          # A unique identifier that defines the default unsubscribe page. If absent, the account/project will
+          # be assigned the system default unsubscribe page.
+          # @return [Integer, nil]
+          attr_accessor :unsubscribe_page_id
+
+          def initialize(
+            id: nil,
+            api_key: nil,
+            name: nil,
+            country: nil,
+            reg_time: nil,
+            send_enabled: nil,
+            custom_unsubscribe_url_enabled: nil,
+            backend_domain_id: nil,
+            email_counter: nil,
+            email_counter_limit: nil,
+            email_counter_mode: nil,
+            unsubscribe_page_id: nil
+          )
+            @id = id
+            @api_key = api_key
+            @name = name
+            @country = country
+            @reg_time = reg_time
+            @send_enabled = send_enabled
+            @custom_unsubscribe_url_enabled = custom_unsubscribe_url_enabled
+            @backend_domain_id = backend_domain_id
+            @email_counter = email_counter
+            @email_counter_limit = email_counter_limit
+            @email_counter_mode = email_counter_mode
+            @unsubscribe_page_id = unsubscribe_page_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(
+              id: data['id'],
+              api_key: data['api_key'],
+              name: data['name'],
+              country: data['country'],
+              reg_time: data['reg_time'],
+              send_enabled: data['send_enabled'],
+              custom_unsubscribe_url_enabled: data['custom_unsubscribe_url_enabled'],
+              backend_domain_id: data['backend_domain_id'],
+              email_counter: data['email_counter'],
+              email_counter_limit: data['email_counter_limit'],
+              email_counter_mode: data['email_counter_mode'],
+              unsubscribe_page_id: data['unsubscribe_page_id']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'id' => @id,
+              'api_key' => @api_key,
+              'name' => @name,
+              'country' => @country,
+              'reg_time' => @reg_time,
+              'send_enabled' => @send_enabled,
+              'custom_unsubscribe_url_enabled' => @custom_unsubscribe_url_enabled,
+              'backend_domain_id' => @backend_domain_id,
+              'email_counter' => @email_counter,
+              'email_counter_limit' => @email_counter_limit,
+              'email_counter_mode' => @email_counter_mode,
+              'unsubscribe_page_id' => @unsubscribe_page_id,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/project/model/project_list_request.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Project
+      module Model
+        # ProjectListRequest
+        class ProjectListRequest
+          # Optional possibility to specify project_id to include only this project to list.
+          # @return [String, nil]
+          attr_accessor :project_id
+
+          # Optional possibility to specify project_api_key to include only this project to list.
+          # @return [String, nil]
+          attr_accessor :project_api_key
+
+          def initialize(
+            project_id: nil,
+            project_api_key: nil
+          )
+            @project_id = project_id
+            @project_api_key = project_api_key
+          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'],
+              project_api_key: data['project_api_key']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'project_id' => @project_id,
+              'project_api_key' => @project_api_key,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/project/model/project_list_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Project
+      module Model
+        # ProjectListResponse
+        class ProjectListResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Array of objects where each object represents one project.
+          # @return [Array<ProjectListObject>, nil]
+          attr_accessor :projects
+
+          def initialize(
+            status: nil,
+            projects: nil
+          )
+            @status = status
+            @projects = 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(
+              status: data['status'],
+              projects: ::UniOne::Client::Decode.list(data['projects']) { |item0| ::UniOne::Client::Decode.model(::UniOne::Api::Project::Model::ProjectListObject, item0) }
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'projects' => @projects.nil? ? nil : @projects.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/project/model/project_object.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Project
+      module Model
+        # Object with project properties.
+        class ProjectObject
+          # Project name, unique for user account.
+          # @return [String, nil]
+          attr_accessor :name
+
+          # ISO-3166 alpha-2 country code. If set, UniOne treats project personal data according to country
+          # laws, e.g. GDPR for european countries.
+          # @return [String, nil]
+          attr_accessor :country
+
+          # Whether email sending is enabled for this project or not.
+          # Default: `True`.
+          # @return [Boolean, nil]
+          attr_accessor :send_enabled
+
+          # If it's false then UniOne adds default unsubscribe footer to each email sent with API key of the
+          # project. If it's true then appending default unsubscribe footer for this project is avoided and
+          # sending with custom unsubscribe url or even without unsubscribe url is permitted for the project.
+          # Please note that custom_unsubscribe_url_enabled=true is available only if removing unsubscribe link
+          # is approved for the user account by support. More on this
+          # [here](https://docs.unione.io/en/unsubscribe-link). When custom_unsubscribe_url_enabled is skipped
+          # on creating a project, it's value is taken from user
+          # @return [Boolean, nil]
+          attr_accessor :custom_unsubscribe_url_enabled
+
+          # A unique domain identifier which will determine the [tracking
+          # domain](https://docs.unione.io/en/tracking-domains) or [dedicated IP](/dedicated-ip) pool to be used
+          # by default. If the value is not specified, a default backend domain will be assigned for your
+          # account or project instead.
+          # @return [Integer, nil]
+          attr_accessor :backend_domain_id
+
+          # A unique identifier that defines the default unsubscribe page. If absent, the account/project will
+          # be assigned the system default unsubscribe page.
+          # @return [Integer, nil]
+          attr_accessor :unsubscribe_page_id
+
+          def initialize(
+            name:,
+            country: nil,
+            send_enabled: nil,
+            custom_unsubscribe_url_enabled: nil,
+            backend_domain_id: nil,
+            unsubscribe_page_id: nil
+          )
+            @name = name
+            @country = country
+            @send_enabled = send_enabled
+            @custom_unsubscribe_url_enabled = custom_unsubscribe_url_enabled
+            @backend_domain_id = backend_domain_id
+            @unsubscribe_page_id = unsubscribe_page_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(
+              name: data['name'],
+              country: data['country'],
+              send_enabled: data['send_enabled'],
+              custom_unsubscribe_url_enabled: data['custom_unsubscribe_url_enabled'],
+              backend_domain_id: data['backend_domain_id'],
+              unsubscribe_page_id: data['unsubscribe_page_id']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'name' => @name,
+              'country' => @country,
+              'send_enabled' => @send_enabled,
+              'custom_unsubscribe_url_enabled' => @custom_unsubscribe_url_enabled,
+              'backend_domain_id' => @backend_domain_id,
+              'unsubscribe_page_id' => @unsubscribe_page_id,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/project/model/project_update_object.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Project
+      module Model
+        # Object with project properties.
+        class ProjectUpdateObject
+          # Project name, unique for user account.
+          # @return [String, nil]
+          attr_accessor :name
+
+          # ISO-3166 alpha-2 country code. If set, UniOne treats project personal data according to country
+          # laws, e.g. GDPR for european countries.
+          # @return [String, nil]
+          attr_accessor :country
+
+          # Whether email sending is enabled for this project or not.
+          # Default: `True`.
+          # @return [Boolean, nil]
+          attr_accessor :send_enabled
+
+          # If it's false then UniOne adds default unsubscribe footer to each email sent with API key of the
+          # project. If it's true then appending default unsubscribe footer for this project is avoided and
+          # sending with custom unsubscribe url or even without unsubscribe url is permitted for the project.
+          # Please note that custom_unsubscribe_url_enabled=true is available only if removing unsubscribe link
+          # is approved for the user account by support. More on this
+          # [here](https://docs.unione.io/en/unsubscribe-link). When custom_unsubscribe_url_enabled is skipped
+          # on creating a project, it's value is taken from user
+          # @return [Boolean, nil]
+          attr_accessor :custom_unsubscribe_url_enabled
+
+          # A unique domain identifier which will determine the [tracking
+          # domain](https://docs.unione.io/en/tracking-domains) or [dedicated IP](/dedicated-ip) pool to be used
+          # by default. If the value is not specified, a default backend domain will be assigned for your
+          # account or project instead.
+          # @return [Integer, nil]
+          attr_accessor :backend_domain_id
+
+          # A unique identifier that defines the default unsubscribe page. If absent, the account/project will
+          # be assigned the system default unsubscribe page.
+          # @return [Integer, nil]
+          attr_accessor :unsubscribe_page_id
+
+          # Project's email counter value. 0 value only is accepted (which means resetting the counter to zero),
+          # or refreshes automatically depending on the counter mode set with the 'email_counter_mode'
+          # parameter. If the request doesn't contain the field or contains null, the limit value doesn't
+          # change.
+          # @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. Setting to 0 means no limit. If the request
+          # doesn't contain the field or contains null, the limit value doesn't change.
+          # Default: `0`.
+          # @return [Integer, nil]
+          attr_accessor :email_counter_limit
+
+          # Sets the email counter mode. It allows you to choose whether the counter should reset automatically,
+          # or remain permanent. The following values are acceptable: 'default' - the counter resets to zero
+          # automatically at the beginning of each accounting period, 'permanent' - the counter never resets
+          # automatically. The reset can be done only manually by the user in the request with the passes 0
+          # value in the email_counter field. If the request doesn't contain the field or contains a null value,
+          # the limit value doesn't change.
+          # Default: `default`.
+          # @return [EmailCounterMode, nil]
+          attr_accessor :email_counter_mode
+
+          def initialize(
+            name:,
+            country: nil,
+            send_enabled: nil,
+            custom_unsubscribe_url_enabled: nil,
+            backend_domain_id: nil,
+            unsubscribe_page_id: nil,
+            email_counter: nil,
+            email_counter_limit: nil,
+            email_counter_mode: nil
+          )
+            @name = name
+            @country = country
+            @send_enabled = send_enabled
+            @custom_unsubscribe_url_enabled = custom_unsubscribe_url_enabled
+            @backend_domain_id = backend_domain_id
+            @unsubscribe_page_id = unsubscribe_page_id
+            @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(
+              name: data['name'],
+              country: data['country'],
+              send_enabled: data['send_enabled'],
+              custom_unsubscribe_url_enabled: data['custom_unsubscribe_url_enabled'],
+              backend_domain_id: data['backend_domain_id'],
+              unsubscribe_page_id: data['unsubscribe_page_id'],
+              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
+            {
+              'name' => @name,
+              'country' => @country,
+              'send_enabled' => @send_enabled,
+              'custom_unsubscribe_url_enabled' => @custom_unsubscribe_url_enabled,
+              'backend_domain_id' => @backend_domain_id,
+              'unsubscribe_page_id' => @unsubscribe_page_id,
+              '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

data/lib/unione/api/project/model/project_update_request.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Project
+      module Model
+        # ProjectUpdateRequest
+        class ProjectUpdateRequest
+          # Unique project identifier. You should identify project to update either with project_id or with
+          # project_api_key field. But we recommend usage of project_id as a more secure option.
+          # @return [String, nil]
+          attr_accessor :project_id
+
+          # Optional project API key. You should identify project to update either with project_id or with
+          # project_api_key field. But we recommend usage of project_id as a more secure option.
+          # @return [String, nil]
+          attr_accessor :project_api_key
+
+          # Object with project properties.
+          # @return [ProjectUpdateObject, nil]
+          attr_accessor :project
+
+          def initialize(
+            project:,
+            project_id: nil,
+            project_api_key: nil
+          )
+            @project_id = project_id
+            @project_api_key = project_api_key
+            @project = project
+          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: ::UniOne::Client::Decode.model(::UniOne::Api::Project::Model::ProjectUpdateObject, data['project']),
+              project_id: data['project_id'],
+              project_api_key: data['project_api_key']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'project_id' => @project_id,
+              'project_api_key' => @project_api_key,
+              'project' => @project.nil? ? nil : @project.to_h,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/project/model/project_update_response.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Project
+      module Model
+        # ProjectUpdateResponse
+        class ProjectUpdateResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # API key of the project. Returned only if the project to update was identified by project_api_key.
+          # Not returned in case of updating by project_id.
+          # @return [String, nil]
+          attr_accessor :project_api_key
+
+          def initialize(
+            status: nil,
+            project_api_key: nil
+          )
+            @status = status
+            @project_api_key = project_api_key
+          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'],
+              project_api_key: data['project_api_key']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'project_api_key' => @project_api_key,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/project/project_api.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module UniOne
+  module Api
+    module Project
+      # Projects allow you to group several independent domains, webhooks, templates, and unsubscription
+      # lists together. It's very useful if you have your own clients and manage their data from a single
+      # UniOne account. Each project receives its own API key, and all API calls with that API key only deal
+      # with the data of that project. This way, you can assign a separate project for each client and be
+      # sure that they won't conflict; e.g. unsubscribing from one project won't affect another.
+      #
+      # Projects methods are disabled by default due to antispam measures. To enable them, [contact
+      # support](https://cp.unione.io/en/support).
+      #
+      # Please note that sending domains are confirmed and used on per-project basis by default. But it's
+      # possible to allow projects to send emails from domains confirmed for main account - just [ask
+      # support](https://cp.unione.io/en/support) to enable it.
+      class ProjectApi
+        # @param client [::UniOne::Client::ApiClient]
+        def initialize(client)
+          @client = client
+        end
+
+        # Creates a new project.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#project-create
+        # @param request [::UniOne::Api::Project::Model::ProjectCreateRequest, Hash]
+        # @return [::UniOne::Api::Project::Model::ProjectCreateResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def create(request)
+          ::UniOne::Api::Project::Model::ProjectCreateResponse.from_h(@client.call('/project/create.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Updates a project.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#project-update
+        # @param request [::UniOne::Api::Project::Model::ProjectUpdateRequest, Hash]
+        # @return [::UniOne::Api::Project::Model::ProjectUpdateResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def update(request)
+          ::UniOne::Api::Project::Model::ProjectUpdateResponse.from_h(@client.call('/project/update.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Lists projects.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#project-list
+        # @param request [::UniOne::Api::Project::Model::ProjectListRequest, Hash]
+        # @return [::UniOne::Api::Project::Model::ProjectListResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def list(request)
+          ::UniOne::Api::Project::Model::ProjectListResponse.from_h(@client.call('/project/list.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Deletes a project.
+        #
+        # The project will be moved to the "trash bin" before being permanently deleted. You can restore the
+        # project by contacting support.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#project-delete
+        # @param request [::UniOne::Api::Project::Model::ProjectDeleteRequest, Hash]
+        # @return [::UniOne::Common::Model::SuccessResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def delete(request)
+          ::UniOne::Common::Model::SuccessResponse.from_h(@client.call('/project/delete.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+      end
+    end
+  end
+end