unione 1.1.3

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module System
+      module Model
+        # SystemInfoResponse
+        class SystemInfoResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Unique user identifier.
+          # @return [Integer, nil]
+          attr_accessor :user_id
+
+          # Email of the user.
+          # @return [String, nil]
+          attr_accessor :email
+
+          # Unqiue project identifier, ASCII string up to 36 characters long. Present only if the API key used
+          # for request is the project API key.
+          # @return [String, nil]
+          attr_accessor :project_id
+
+          # Project name, unique for user account. Present only if the API key used for request is the project
+          # API key.
+          # @return [String, nil]
+          attr_accessor :project_name
+
+          # Object with email counter properties. Present only if the API key used for request is the user API
+          # key.
+          # @return [ProjectAccountingObject, nil]
+          attr_accessor :project_accounting
+
+          # Object with accounting period properties. Present only if the API key used for request is the user
+          # API key.
+          # @return [SystemInfoResponseAccounting, nil]
+          attr_accessor :accounting
+
+          def initialize(
+            status: nil,
+            user_id: nil,
+            email: nil,
+            project_id: nil,
+            project_name: nil,
+            project_accounting: nil,
+            accounting: nil
+          )
+            @status = status
+            @user_id = user_id
+            @email = email
+            @project_id = project_id
+            @project_name = project_name
+            @project_accounting = project_accounting
+            @accounting = accounting
+          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'],
+              user_id: data['user_id'],
+              email: data['email'],
+              project_id: data['project_id'],
+              project_name: data['project_name'],
+              project_accounting: ::UniOne::Client::Decode.model(::UniOne::Api::System::Model::ProjectAccountingObject, data['project_accounting']),
+              accounting: ::UniOne::Client::Decode.model(::UniOne::Api::System::Model::SystemInfoResponseAccounting, data['accounting'])
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'user_id' => @user_id,
+              'email' => @email,
+              'project_id' => @project_id,
+              'project_name' => @project_name,
+              'project_accounting' => @project_accounting.nil? ? nil : @project_accounting.to_h,
+              'accounting' => @accounting.nil? ? nil : @accounting.to_h,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module System
+      module Model
+        # Object with accounting period properties. Present only if the API key used for request is the user
+        # API key.
+        class SystemInfoResponseAccounting
+          # Date and time of accounting period start in UTC in "YYYY-MM-DD hh:mm:ss" format.
+          # @return [String, nil]
+          attr_accessor :period_start
+
+          # Date and time of accounting period end in UTC in "YYYY-MM-DD hh:mm:ss" format.
+          # @return [String, nil]
+          attr_accessor :period_end
+
+          # Number of emails included into accounting period.
+          # @return [Integer, nil]
+          attr_accessor :emails_included
+
+          # Number of emails sent during accounting period. Can be bigger than emails_included in case of
+          # overage.
+          # @return [Integer, nil]
+          attr_accessor :emails_sent
+
+          def initialize(
+            period_start: nil,
+            period_end: nil,
+            emails_included: nil,
+            emails_sent: nil
+          )
+            @period_start = period_start
+            @period_end = period_end
+            @emails_included = emails_included
+            @emails_sent = emails_sent
+          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(
+              period_start: data['period_start'],
+              period_end: data['period_end'],
+              emails_included: data['emails_included'],
+              emails_sent: data['emails_sent']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'period_start' => @period_start,
+              'period_end' => @period_end,
+              'emails_included' => @emails_included,
+              'emails_sent' => @emails_sent,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module System
+      module Model
+        # SystemPingResponse
+        class SystemPingResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Unique user identifier.
+          # @return [Integer, nil]
+          attr_accessor :user_id
+
+          def initialize(
+            status: nil,
+            user_id: nil
+          )
+            @status = status
+            @user_id = user_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'],
+              user_id: data['user_id']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'user_id' => @user_id,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/system/system_api.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module UniOne
+  module Api
+    module System
+      # System operations.
+      class SystemApi
+        # @param client [::UniOne::Client::ApiClient]
+        def initialize(client)
+          @client = client
+        end
+
+        # Checks API key validity and returns user ID.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#system-ping
+        # @return [::UniOne::Api::System::Model::SystemPingResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def ping
+          ::UniOne::Api::System::Model::SystemPingResponse.from_h(@client.call('/system/ping.json'))
+        end
+
+        # Gets user or project info by API key.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#system-info
+        # @return [::UniOne::Api::System::Model::SystemInfoResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def info
+          ::UniOne::Api::System::Model::SystemInfoResponse.from_h(@client.call('/system/info.json'))
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/tag/model/tag_delete_request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Tag
+      module Model
+        # TagDeleteRequest
+        class TagDeleteRequest
+          # Unique tag id.
+          # @return [Integer, nil]
+          attr_accessor :tag_id
+
+          def initialize(
+            tag_id:
+          )
+            @tag_id = tag_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(
+              tag_id: data['tag_id']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'tag_id' => @tag_id,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/tag/model/tag_list_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Tag
+      module Model
+        # TagListResponse
+        class TagListResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # An array of objects containing data for user-defined tags.
+          # @return [Array<TagsResponseObject>, nil]
+          attr_accessor :tags
+
+          def initialize(
+            status: nil,
+            tags: nil
+          )
+            @status = status
+            @tags = tags
+          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'],
+              tags: ::UniOne::Client::Decode.list(data['tags']) { |item0| ::UniOne::Client::Decode.model(::UniOne::Api::Tag::Model::TagsResponseObject, item0) }
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'tags' => @tags.nil? ? nil : @tags.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/tag/model/tags_response_object.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Tag
+      module Model
+        # An object with the properties of the user tags.
+        class TagsResponseObject
+          # Unique tag id.
+          # @return [Integer, nil]
+          attr_accessor :tag_id
+
+          # Tag name.
+          # @return [String, nil]
+          attr_accessor :tag
+
+          def initialize(
+            tag_id: nil,
+            tag: nil
+          )
+            @tag_id = tag_id
+            @tag = tag
+          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(
+              tag_id: data['tag_id'],
+              tag: data['tag']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'tag_id' => @tag_id,
+              'tag' => @tag,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/tag/tag_api.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module UniOne
+  module Api
+    module Tag
+      # This family of methods is used to manage user-defined tags. Tags are used to categorize letters
+      # based on your own criteria, e. g. to create a distinction between marketing and transactional
+      # letters or group together all notifications for a particular order type. UniOne allows you to assign
+      # tags to all outgoing emails, and the tags you’ve set may then be used to filter and analyze delivery
+      # statistics.
+      class TagApi
+        # @param client [::UniOne::Client::ApiClient]
+        def initialize(client)
+          @client = client
+        end
+
+        # This method returns the full list of user-defined tags. Does not receive any parameters.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#tag-list
+        # @return [::UniOne::Api::Tag::Model::TagListResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def list
+          ::UniOne::Api::Tag::Model::TagListResponse.from_h(@client.call('/tag/list.json'))
+        end
+
+        # Removes tag.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#tag-delete
+        # @param request [::UniOne::Api::Tag::Model::TagDeleteRequest, Hash]
+        # @return [::UniOne::Common::Model::SuccessResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def delete(request)
+          ::UniOne::Common::Model::SuccessResponse.from_h(@client.call('/tag/delete.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/template/model/editor_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Template
+      module Model
+        # Editor type, "html" or "visual". Default is "html". You can create a template with "visual" editor
+        # type only in web interface.
+        module EditorType
+          HTML = 'html'
+          VISUAL = 'visual'
+
+          # All values
+          ALL = [HTML, VISUAL].freeze
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/template/model/template_delete_request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Template
+      module Model
+        # TemplateDeleteRequest
+        class TemplateDeleteRequest
+          # Template id.
+          # @return [String, nil]
+          attr_accessor :id
+
+          def initialize(
+            id:
+          )
+            @id = 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']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'id' => @id,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/template/model/template_get_request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Template
+      module Model
+        # TemplateGetRequest
+        class TemplateGetRequest
+          # Template id.
+          # @return [String, nil]
+          attr_accessor :id
+
+          def initialize(
+            id:
+          )
+            @id = 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']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'id' => @id,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/template/model/template_get_response.rb

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