unione 1.1.3

data/docs/Template.md

@@ -0,0 +1,164 @@
+# Template
+
+[Back to the list of sections](../README.md)
+
+You have the option of storing a template on the UniOne side and then using it by id, which is highly recommended for sending repetitive messages or high volume traffic. UniOne supports two different [template engines](https://docs.unione.io/en/template-engines).
+
+`UniOne::Api::Template::TemplateApi`, `client.template`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`set`](#set) | `POST /template/set.json` | Creates or updates an email template. |
+| [`get`](#get) | `POST /template/get.json` | Gets template properties by it's id. |
+| [`list`](#list) | `POST /template/list.json` | Returns the list of all or some templates of the account. |
+| [`delete`](#delete) | `POST /template/delete.json` | Deletes a template by id. |
+
+## set
+
+`POST /template/set.json` · [Documentation](https://docs.unione.io/en/web-api-ref#template-set)
+
+Creates or updates an email template.
+
+Restrictions:
+* The maximum request size is 10 MB.
+* The number of templates is limited to 10000.
+
+### Request: `TemplateSetRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `template` | `TemplateObject` | yes | Object with all the template properties. |
+
+### Response: `TemplateSetResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `template` | `TemplateObject` | Object with all the template properties. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Common = UniOne::Common::Model
+Template = UniOne::Api::Template::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.template.set(Template::TemplateSetRequest.new(
+  template: Template::TemplateObject.new(
+    name: 'name',
+    editor_type: Template::EditorType::HTML,
+    template_engine: Common::TemplateEngine::VELOCITY,
+    subject: 'UniOne test email ',
+    from_email: 'user@example.com',
+    from_name: 'John Smith',
+    reply_to: 'email@example.com',
+    reply_to_name: 'John Smith'
+  )
+))
+p response.template
+```
+
+## get
+
+`POST /template/get.json` · [Documentation](https://docs.unione.io/en/web-api-ref#template-get)
+
+Gets template properties by it's id.
+
+### Request: `TemplateGetRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `String` | yes | Template id. |
+
+### Response: `TemplateGetResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `template` | `TemplateObject` | Object with all the template properties. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Template = UniOne::Api::Template::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.template.get(Template::TemplateGetRequest.new(
+  id: '00000000-0000-0000-0000-000000000000'
+))
+p response.template
+```
+
+## list
+
+`POST /template/list.json` · [Documentation](https://docs.unione.io/en/web-api-ref#template-list)
+
+Returns the list of all or some templates of the account.
+
+You can iterate thru large list using "offset" and "limit" parameters. When less than "limit" templates are returned then the end of list is reached.
+
+### Request: `TemplateListRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `limit` | `Integer` |  | Limits the number of templates returned, default is 50. |
+| `offset` | `Integer` |  | Index of the first template in the list, starting with 0. |
+
+### Response: `TemplateListResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `templates` | `Array<TemplateListObject>` | Array of template objects. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Template = UniOne::Api::Template::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.template.list(Template::TemplateListRequest.new)
+p response.templates
+```
+
+## delete
+
+`POST /template/delete.json` · [Documentation](https://docs.unione.io/en/web-api-ref#template-delete)
+
+Deletes a template by id.
+
+### Request: `TemplateDeleteRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `String` | yes | Template id. |
+
+### Response: `SuccessResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+
+### Example
+
+```ruby
+require 'unione'
+
+Template = UniOne::Api::Template::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.template.delete(Template::TemplateDeleteRequest.new(
+  id: '00000000-0000-0000-0000-000000000000'
+))
+p response
+```

data/docs/Webhook.md

@@ -0,0 +1,182 @@
+# Webhook
+
+[Back to the list of sections](../README.md)
+
+UniOne lets you recieve notifications about email status changes or spam blocks. You provide an URL and every time a watched event occurs we will notify you by submitting a request with JSON data to this URL.
+
+You can configure the format of webhook calls (JSON or gzipped JSON), which events you want to be notified of, whether or not you let us groups several events in one request, do you want to receive extra details like SMTP answer or recipient's user agent, etc.
+
+Please note that your webhook handler should be able to process at least 5 parallel requests, up to 100 events each (but you can configure the maximum number of parallel connections up to 100, which is recommended).
+
+If the URL of your webhook handler is not available (the response is not HTTP 200 OK within 3 seconds timeout), the system will repeat requests each 10 minutes during 24 hours, passing extra parameter retry_count. If there were at least 10 events during last 24 hours and all the webhook requests about these events have failed then we consider webhook handler broken and change it's status to inactive automatically. A notification about that is sent to an email [configured in control panel](https://cp.unione.io/en/user/alerting/technical/).
+
+The format of webhook request and details of each event are described [here](https://docs.unione.io/en/web-api-ref#callback-format).
+
+`UniOne::Api::Webhook::WebhookApi`, `client.webhook`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`set`](#set) | `POST /webhook/set.json` | Sets or edits a [webhook](https://docs.unione.io/en/web-api-ref#webhook), i.e. an event notification handler. |
+| [`get`](#get) | `POST /webhook/get.json` | Gets properties of a [webhook](https://docs.unione.io/en/web-api-ref#webhook). |
+| [`list`](#list) | `POST /webhook/list.json` | List all or some [webhooks](https://docs.unione.io/en/web-api-ref#webhook) (event notification handlers) of a user or a project. |
+| [`delete`](#delete) | `POST /webhook/delete.json` | Deletes an event notification handler |
+
+## set
+
+`POST /webhook/set.json` · [Documentation](https://docs.unione.io/en/web-api-ref#webhook-set)
+
+Sets or edits a [webhook](https://docs.unione.io/en/web-api-ref#webhook), i.e. an event notification handler.
+
+### Request: `WebhookSetRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `url` | `String` | yes | URL that will receive the notification when an event occurs. The URL should be unique for a user or a project. Only ASCII characters are supported for now in URL, please convert to [Punycode](https://en.wikipedia.org/wiki/Punycode) if you need to use non-ASCII characters. |
+| `status` | `WebhookStatus` |  | Webhook status, "active" by default. "disabled" means that webhook has been disabled by the user, "stopped" means that webhook has been stopped by the system after 24h of failed calls (with minimum of 10 distinct events). (`active`, `disabled`, `stopped`) |
+| `event_format` | `WebhookEventFormat` |  | Notification format. "json_post"(default) or "json_post_gzip". (`json_post`, `json_post_gzip`) |
+| `delivery_info` | `Integer` |  | Shall detailed delivery info be returned(1) or not(0). When it's 1, the information about SMTP response and internal delivery status is returned for "hard_bounced" and "soft_bounced" email statuses; the user agent, recipient IP address, detected geo fields, device info detected from the user agent (device type and brand, OS name, browser or email client name) and traffic_type (human, machine, protected or unknown) are returned for "opened" and "clicked" statuses; URL is returned for "clicked" status. For "delivered", "soft_bounced" and "hard_bounced" statuses UniOne may also return sender_ip, the IP address of the SMTP server that sent the message, if available. (`0`, `1`) |
+| `single_event` | `Integer` |  | 0=several event notifications can be reported in single webhook call, 1=only single event can be reported in one call (not recommended). (`0`, `1`) |
+| `max_parallel` | `Integer` |  | Maximum quantity of permitted parallel queries to your server. The more your server can handle - the better. |
+| `events` | `WebhookEventsObject` |  | Object containing events to notify of. |
+
+### Response: `WebhookSetResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `object` | `WebhookObject` | Object with all the webhook properties. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Webhook = UniOne::Api::Webhook::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.webhook.set(Webhook::WebhookSetRequest.new(
+  url: 'https://yourhost.example.com/unione-webhook'
+))
+p response.object
+```
+
+## get
+
+`POST /webhook/get.json` · [Documentation](https://docs.unione.io/en/web-api-ref#webhook-get)
+
+Gets properties of a [webhook](https://docs.unione.io/en/web-api-ref#webhook).
+
+### Request: `WebhookGetRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `url` | `String` | yes | Webhook URL. |
+
+### Response: `WebhookGetResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `object` | `WebhookObject` | Object with all the webhook properties. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Webhook = UniOne::Api::Webhook::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.webhook.get(Webhook::WebhookGetRequest.new(
+  url: 'https://example.com/webhook'
+))
+p response.object
+```
+
+## list
+
+`POST /webhook/list.json` · [Documentation](https://docs.unione.io/en/web-api-ref#webhook-list)
+
+List all or some [webhooks](https://docs.unione.io/en/web-api-ref#webhook) (event notification handlers) of a user or a project.
+
+### Request: `WebhookListRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `limit` | `Integer` |  | Limits the number of webhooks returned. 50 is recommended. |
+| `offset` | `Integer` |  | Index of the first webhook in the list, starting with 0. |
+
+### Response: `WebhookListResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `objects` | `Array<WebhookObject>` | Array of webhooks objects. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Webhook = UniOne::Api::Webhook::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.webhook.list(Webhook::WebhookListRequest.new)
+p response.objects
+```
+
+## delete
+
+`POST /webhook/delete.json` · [Documentation](https://docs.unione.io/en/web-api-ref#webhook-delete)
+
+Deletes an event notification handler
+
+You can also temporarily deactivate webhook without deleting it by setting it's status to "disabled" in [webhook/set](https://docs.unione.io/en/web-api-ref#webhook-set) method.
+
+### Request: `WebhookDeleteRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `url` | `String` | yes | Webhook URL. |
+
+### Response: `SuccessResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+
+### Example
+
+```ruby
+require 'unione'
+
+Webhook = UniOne::Api::Webhook::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.webhook.delete(Webhook::WebhookDeleteRequest.new(
+  url: 'https://example.com/webhook'
+))
+p response
+```
+
+## Callbacks: `WebhookCallback`
+
+Webhook callback format description.
+
+Parse an incoming webhook request body:
+
+```ruby
+require 'unione'
+
+callback = UniOne::Api::Webhook::WebhookApi.parse_callback(request.body.read)
+p callback
+```
+
+| Field | Type | Description |
+|---|---|---|
+| `auth` | `String` | MD5-hash of the message body, in which the value "auth" is replaced by api key of the user/project; with this field the recipient of the notification can both authenticate and verify the notification integrity |
+| `events_by_user` | `Array<WebhookCallbackEventsByUserItem>` | Array with only one element, containing events of a user/project. |

data/lib/unione/api/confirmed_email/confirmed_email_api.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module UniOne
+  module Api
+    module ConfirmedEmail
+      # Manage email addresses confirmed for sandbox-domain sending. These methods are available only with a
+      # main account API key.
+      class ConfirmedEmailApi
+        # @param client [::UniOne::Client::ApiClient]
+        def initialize(client)
+          @client = client
+        end
+
+        # Adds an email address and sends a confirmation link.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#confirmed-email-create
+        # @param request [::UniOne::Api::ConfirmedEmail::Model::ConfirmedEmailRequest, Hash]
+        # @return [::UniOne::Api::ConfirmedEmail::Model::ConfirmedEmailCreateResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def create(request)
+          ::UniOne::Api::ConfirmedEmail::Model::ConfirmedEmailCreateResponse.from_h(@client.call('/confirmed-email/create.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+
+        # Lists confirmed and unconfirmed email addresses for the account.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#confirmed-email-list
+        # @return [::UniOne::Api::ConfirmedEmail::Model::ConfirmedEmailListResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def list
+          ::UniOne::Api::ConfirmedEmail::Model::ConfirmedEmailListResponse.from_h(@client.call('/confirmed-email/list.json'))
+        end
+
+        # Deletes an email address from the account's confirmed email list.
+        #
+        # Documentation: https://docs.unione.io/en/web-api-ref#confirmed-email-delete
+        # @param request [::UniOne::Api::ConfirmedEmail::Model::ConfirmedEmailRequest, Hash]
+        # @return [::UniOne::Api::ConfirmedEmail::Model::ConfirmedEmailDeleteResponse]
+        # @raise [::UniOne::Client::ApiError]
+        def delete(request)
+          ::UniOne::Api::ConfirmedEmail::Model::ConfirmedEmailDeleteResponse.from_h(@client.call('/confirmed-email/delete.json', request.is_a?(Hash) ? request : request.to_h))
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/confirmed_email/model/confirmed_email.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module ConfirmedEmail
+      module Model
+        # ConfirmedEmail
+        class ConfirmedEmail
+          # @return [String, nil]
+          attr_accessor :email
+
+          # Confirmation status of the email address.
+          # @return [VerificationRecordStatus, nil]
+          attr_accessor :status
+
+          def initialize(
+            email: nil,
+            status: nil
+          )
+            @email = email
+            @status = status
+          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'],
+              status: data['status']
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'email' => @email,
+              'status' => @status,
+            }.compact
+          end
+
+          def to_json(*args)
+            to_h.to_json(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unione/api/confirmed_email/model/confirmed_email_create_response.rb

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

data/lib/unione/api/confirmed_email/model/confirmed_email_delete_response.rb

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

data/lib/unione/api/confirmed_email/model/confirmed_email_list_response.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module ConfirmedEmail
+      module Model
+        # ConfirmedEmailListResponse
+        class ConfirmedEmailListResponse
+          # "success" string
+          # Allowed values: `success`.
+          # @return [String, nil]
+          attr_accessor :status
+
+          # @return [Array<ConfirmedEmail>, nil]
+          attr_accessor :confirmed_emails
+
+          def initialize(
+            status: nil,
+            confirmed_emails: nil
+          )
+            @status = status
+            @confirmed_emails = confirmed_emails
+          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'],
+              confirmed_emails: ::UniOne::Client::Decode.list(data['confirmed_emails']) { |item0| ::UniOne::Client::Decode.model(::UniOne::Api::ConfirmedEmail::Model::ConfirmedEmail, item0) }
+            )
+          end
+
+          # JSON-ready hash, nil fields are omitted.
+          def to_h
+            {
+              'status' => @status,
+              'confirmed_emails' => @confirmed_emails.nil? ? nil : @confirmed_emails.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/confirmed_email/model/confirmed_email_request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UniOne
+  module Api
+    module ConfirmedEmail
+      module Model
+        # ConfirmedEmailRequest
+        class ConfirmedEmailRequest
+          # Email address to add or delete.
+          # @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