unione 1.1.3

data/lib/unione/api/obsolete/model/obsolete_unsubscribed_check_request.rb

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

data/lib/unione/api/obsolete/model/obsolete_unsubscribed_check_response.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Obsolete
+      module Model
+        # ObsoleteUnsubscribedCheckResponse
+        class ObsoleteUnsubscribedCheckResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Email that was checked.
+          # @return [String, nil]
+          attr_accessor :address
+
+          # true if unsubscribed, false if not.
+          # @return [Boolean, nil]
+          attr_accessor :is_unsubscribed
+
+          def initialize(
+            status: nil,
+            address: nil,
+            is_unsubscribed: nil
+          )
+            @status = status
+            @address = address
+            @is_unsubscribed = is_unsubscribed
+          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'],
+              address: data['address'],
+              is_unsubscribed: data['is_unsubscribed']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'address' => @address,
+              'is_unsubscribed' => @is_unsubscribed,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/obsolete/model/obsolete_unsubscribed_list_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Obsolete
+      module Model
+        # ObsoleteUnsubscribedListRequest
+        class ObsoleteUnsubscribedListRequest
+          # Date in the format YYYY-MM-DD to get all unsubscribed emails from the "date_from" to the present
+          # day. If the parameter is not specified, the default period is today (from 00:00 UTC).
+          # @return [String, nil]
+          attr_accessor :date_from
+
+          def initialize(
+            date_from: nil
+          )
+            @date_from = date_from
+          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(
+              date_from: data['date_from']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'date_from' => @date_from,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/obsolete/model/obsolete_unsubscribed_list_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Obsolete
+      module Model
+        # ObsoleteUnsubscribedListResponse
+        class ObsoleteUnsubscribedListResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Array of object describing unsubscribed emails.
+          # @return [Array<ObsoleteUnsubscribedListResponseUnsubscribedItem>, nil]
+          attr_accessor :unsubscribed
+
+          def initialize(
+            status: nil,
+            unsubscribed: nil
+          )
+            @status = status
+            @unsubscribed = unsubscribed
+          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'],
+              unsubscribed: ::UniOne::Client::Decode.list(data['unsubscribed']) { |item0| ::UniOne::Client::Decode.model(::UniOne::Api::Obsolete::Model::ObsoleteUnsubscribedListResponseUnsubscribedItem, item0) }
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'unsubscribed' => @unsubscribed.nil? ? nil : @unsubscribed.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/obsolete/model/obsolete_unsubscribed_list_response_unsubscribed_item.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Obsolete
+      module Model
+        # ObsoleteUnsubscribedListResponseUnsubscribedItem
+        class ObsoleteUnsubscribedListResponseUnsubscribedItem
+          # Unsubscribed email.
+          # @return [String, nil]
+          attr_accessor :address
+
+          # Date and time when a recipient unsubscribed, in UTC timezone and "YYYY-MM-DD hh:mm:ss" format.
+          # @return [String, nil]
+          attr_accessor :unsubscribed_on
+
+          def initialize(
+            address: nil,
+            unsubscribed_on: nil
+          )
+            @address = address
+            @unsubscribed_on = unsubscribed_on
+          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(
+              address: data['address'],
+              unsubscribed_on: data['unsubscribed_on']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'address' => @address,
+              'unsubscribed_on' => @unsubscribed_on,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/obsolete/model/obsolete_unsubscribed_set_message.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Obsolete
+      module Model
+        # Unsubscription process details:
+        #
+        # - "unsubscribed" if email has just been unsubscribed,
+        # - "was inactive" if it was inactive due some reason,
+        # - "was unsubscribed" if it already was unsubscribed before the call,
+        # - "added and unsubscribed" if it's a new email without status history and it was added and then unsubscribed immediately.
+        module ObsoleteUnsubscribedSetMessage
+          UNSUBSCRIBED = 'unsubscribed'
+          WAS_INACTIVE = 'was inactive'
+          WAS_UNSUBSCRIBED = 'was unsubscribed'
+          ADDED_AND_UNSUBSCRIBED = 'added and unsubscribed'
+
+          # All values
+          ALL = [UNSUBSCRIBED, WAS_INACTIVE, WAS_UNSUBSCRIBED, ADDED_AND_UNSUBSCRIBED].freeze
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/obsolete/model/obsolete_unsubscribed_set_request.rb

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

data/lib/unione/api/obsolete/model/obsolete_unsubscribed_set_response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Obsolete
+      module Model
+        # ObsoleteUnsubscribedSetResponse
+        class ObsoleteUnsubscribedSetResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # The unsubscribed email.
+          # @return [String, nil]
+          attr_accessor :address
+
+          # Unsubscription process details:
+          #
+          # - "unsubscribed" if email has just been unsubscribed,
+          # - "was inactive" if it was inactive due some reason,
+          # - "was unsubscribed" if it already was unsubscribed before the call,
+          # - "added and unsubscribed" if it's a new email without status history and it was added and then unsubscribed immediately.
+          # @return [ObsoleteUnsubscribedSetMessage, nil]
+          attr_accessor :message
+
+          def initialize(
+            status: nil,
+            address: nil,
+            message: nil
+          )
+            @status = status
+            @address = address
+            @message = message
+          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'],
+              address: data['address'],
+              message: data['message']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'address' => @address,
+              'message' => @message,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/obsolete/obsolete_api.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module UniOne
+  module Api
+    module Obsolete
+      # Obsolete methods dealing with unsubscribes. We recommend using the more flexible
+      # [suppression](https://docs.unione.io/en/web-api-ref#suppression) methods instead. Note that you
+      # can't resubscribe an unsubscribed recipient using WebAPI, but you can send him an email with
+      # subscription link using email/subscribe method.
+      class ObsoleteApi
+        # @param client [::UniOne::Client::ApiClient]
+        def initialize(client)
+          @client = client
+        end
+
+        # Registers a new unsubscribed email.
+        #
+        # After registering an email as unsubscribed all future attempts to send a message to this email will
+        # be rejected. Please note that there's no way to remove an email from unsubscribed thru the API. But
+        # you can send an email with a link to resubscribe using
+        # [email/subscribe](https://docs.unione.io/en/web-api-ref#email-subscribe) method or remove
+        # "unsubscribed" status manually on [Email Search page](https://cp.unione.io/en/user/email) in control
+        # panel (but only a limited number of unsubscribed email per day can be removed).
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#unsubscribed-set
+        # @param request [::UniOne::Api::Obsolete::Model::ObsoleteUnsubscribedSetRequest, Hash]
+        # @return [::UniOne::Api::Obsolete::Model::ObsoleteUnsubscribedSetResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def unsubscribed_set(request)
+          ::UniOne::Api::Obsolete::Model::ObsoleteUnsubscribedSetResponse.from_h(@client.call('/unsubscribed/set.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Checks if an email is unsubscribed.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#unsubscribed-check
+        # @param request [::UniOne::Api::Obsolete::Model::ObsoleteUnsubscribedCheckRequest, Hash]
+        # @return [::UniOne::Api::Obsolete::Model::ObsoleteUnsubscribedCheckResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def unsubscribed_check(request)
+          ::UniOne::Api::Obsolete::Model::ObsoleteUnsubscribedCheckResponse.from_h(@client.call('/unsubscribed/check.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Returns a list of all unsubscribed emails since provided date.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#unsubscribed-list
+        # @param request [::UniOne::Api::Obsolete::Model::ObsoleteUnsubscribedListRequest, Hash]
+        # @return [::UniOne::Api::Obsolete::Model::ObsoleteUnsubscribedListResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def unsubscribed_list(request)
+          ::UniOne::Api::Obsolete::Model::ObsoleteUnsubscribedListResponse.from_h(@client.call('/unsubscribed/list.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Project
+      module Model
+        # ProjectCreateRequest
+        class ProjectCreateRequest
+          # Object with project properties.
+          # @return [ProjectObject, nil]
+          attr_accessor :project
+
+          def initialize(
+            project:
+          )
+            @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::ProjectObject, data['project'])
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              '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_create_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Project
+      module Model
+        # ProjectCreateResponse
+        class ProjectCreateResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # Unqiue project identifier, ASCII string up to 36 characters long.
+          # @return [String, nil]
+          attr_accessor :project_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 :project_api_key
+
+          def initialize(
+            status: nil,
+            project_id: nil,
+            project_api_key: nil
+          )
+            @status = status
+            @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(
+              status: data['status'],
+              project_id: data['project_id'],
+              project_api_key: data['project_api_key']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              '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_delete_request.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module Project
+      module Model
+        # ProjectDeleteRequest
+        class ProjectDeleteRequest
+          # Unique project identifier. You should identify project to delete either with project_id or with
+          # project_api_key field. 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 delete either with project_id or with
+          # project_api_key field. We recommend usage of project_id as a more secure option.
+          # @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