unione 1.1.3

data/docs/Obsolete.md

@@ -0,0 +1,119 @@
+# Obsolete
+
+[Back to the list of sections](../README.md)
+
+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.
+
+`UniOne::Api::Obsolete::ObsoleteApi`, `client.obsolete`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`unsubscribed_set`](#unsubscribed_set) | `POST /unsubscribed/set.json` | Registers a new unsubscribed email. |
+| [`unsubscribed_check`](#unsubscribed_check) | `POST /unsubscribed/check.json` | Checks if an email is unsubscribed. |
+| [`unsubscribed_list`](#unsubscribed_list) | `POST /unsubscribed/list.json` | Returns a list of all unsubscribed emails since provided date. |
+
+## unsubscribed_set
+
+`POST /unsubscribed/set.json` · [Documentation](https://docs.unione.io/en/web-api-ref#unsubscribed-set)
+
+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).
+
+### Request: `ObsoleteUnsubscribedSetRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `address` | `String` | yes | Email to be unsubscribed. |
+
+### Response: `ObsoleteUnsubscribedSetResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `address` | `String` | The unsubscribed email. |
+| `message` | `ObsoleteUnsubscribedSetMessage` | Unsubscription process details:<br><br>- "unsubscribed" if email has just been unsubscribed,<br>- "was inactive" if it was inactive due some reason,<br>- "was unsubscribed" if it already was unsubscribed before the call,<br>- "added and unsubscribed" if it's a new email without status history and it was added and then unsubscribed immediately. (`unsubscribed`, `was inactive`, `was unsubscribed`, `added and unsubscribed`) |
+
+### Example
+
+```ruby
+require 'unione'
+
+Obsolete = UniOne::Api::Obsolete::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.obsolete.unsubscribed_set(Obsolete::ObsoleteUnsubscribedSetRequest.new(
+  address: 'email@example.com'
+))
+p response.address
+```
+
+## unsubscribed_check
+
+`POST /unsubscribed/check.json` · [Documentation](https://docs.unione.io/en/web-api-ref#unsubscribed-check)
+
+Checks if an email is unsubscribed.
+
+### Request: `ObsoleteUnsubscribedCheckRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `address` | `String` | yes | Email to check. |
+
+### Response: `ObsoleteUnsubscribedCheckResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `address` | `String` | Email that was checked. |
+| `is_unsubscribed` | `Boolean` | true if unsubscribed, false if not. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Obsolete = UniOne::Api::Obsolete::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.obsolete.unsubscribed_check(Obsolete::ObsoleteUnsubscribedCheckRequest.new(
+  address: 'email@example.com'
+))
+p response.address
+```
+
+## unsubscribed_list
+
+`POST /unsubscribed/list.json` · [Documentation](https://docs.unione.io/en/web-api-ref#unsubscribed-list)
+
+Returns a list of all unsubscribed emails since provided date.
+
+### Request: `ObsoleteUnsubscribedListRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `date_from` | `String` |  | 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). |
+
+### Response: `ObsoleteUnsubscribedListResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `unsubscribed` | `Array<ObsoleteUnsubscribedListResponseUnsubscribedItem>` | Array of object describing unsubscribed emails. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Obsolete = UniOne::Api::Obsolete::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.obsolete.unsubscribed_list(Obsolete::ObsoleteUnsubscribedListRequest.new(
+  date_from: '2020-10-14'
+))
+p response.unsubscribed
+```

data/docs/Project.md

@@ -0,0 +1,174 @@
+# Project
+
+[Back to the list of sections](../README.md)
+
+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.
+
+`UniOne::Api::Project::ProjectApi`, `client.project`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`create`](#create) | `POST /project/create.json` | Creates a new project. |
+| [`update`](#update) | `POST /project/update.json` | Updates a project. |
+| [`list`](#list) | `POST /project/list.json` | Lists projects. |
+| [`delete`](#delete) | `POST /project/delete.json` | Deletes a project. |
+
+## create
+
+`POST /project/create.json` · [Documentation](https://docs.unione.io/en/web-api-ref#project-create)
+
+Creates a new project.
+
+### Request: `ProjectCreateRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `project` | `ProjectObject` | yes | Object with project properties. |
+
+### Response: `ProjectCreateResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `project_id` | `String` | Unqiue project identifier, ASCII string up to 36 characters long. |
+| `project_api_key` | `String` | API key of the project. You can use it instead of the user API key parameter in all methods except project/* methods. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Project = UniOne::Api::Project::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.project.create(Project::ProjectCreateRequest.new(
+  project: Project::ProjectObject.new(
+    name: 'Project 1A',
+    country: 'ES',
+    backend_domain_id: 1234,
+    unsubscribe_page_id: 1
+  )
+))
+p response.project_id
+```
+
+## update
+
+`POST /project/update.json` · [Documentation](https://docs.unione.io/en/web-api-ref#project-update)
+
+Updates a project.
+
+### Request: `ProjectUpdateRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `project_id` | `String` |  | 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. |
+| `project_api_key` | `String` |  | 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. |
+| `project` | `ProjectUpdateObject` | yes | Object with project properties. |
+
+### Response: `ProjectUpdateResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `project_api_key` | `String` | 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. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Project = UniOne::Api::Project::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.project.update(Project::ProjectUpdateRequest.new(
+  project_id: '1234567890',
+  project_api_key: 'your api_key',
+  project: Project::ProjectUpdateObject.new(
+    name: 'Project 1A',
+    country: 'ES',
+    backend_domain_id: 1234,
+    unsubscribe_page_id: 1
+  )
+))
+p response.project_api_key
+```
+
+## list
+
+`POST /project/list.json` · [Documentation](https://docs.unione.io/en/web-api-ref#project-list)
+
+Lists projects.
+
+### Request: `ProjectListRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `project_id` | `String` |  | Optional possibility to specify project_id to include only this project to list. |
+| `project_api_key` | `String` |  | Optional possibility to specify project_api_key to include only this project to list. |
+
+### Response: `ProjectListResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `projects` | `Array<ProjectListObject>` | Array of objects where each object represents one project. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Project = UniOne::Api::Project::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.project.list(Project::ProjectListRequest.new(
+  project_id: '1234567890',
+  project_api_key: 'your api_key'
+))
+p response.projects
+```
+
+## delete
+
+`POST /project/delete.json` · [Documentation](https://docs.unione.io/en/web-api-ref#project-delete)
+
+Deletes a project.
+
+The project will be moved to the "trash bin" before being permanently deleted. You can restore the project by contacting support.
+
+### Request: `ProjectDeleteRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `project_id` | `String` |  | 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. |
+| `project_api_key` | `String` |  | 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. |
+
+### Response: `SuccessResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+
+### Example
+
+```ruby
+require 'unione'
+
+Project = UniOne::Api::Project::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.project.delete(Project::ProjectDeleteRequest.new(
+  project_id: '1234567890',
+  project_api_key: 'your api_key'
+))
+p response
+```

data/docs/Suppression.md

@@ -0,0 +1,163 @@
+# Suppression
+
+[Back to the list of sections](../README.md)
+
+Methods for managing suppression lists. An email can be added to suppression list because of unsubscription, bounce or complain.
+
+`UniOne::Api::Suppression::SuppressionApi`, `client.suppression`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`set`](#set) | `POST /suppression/set.json` | 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. |
+| [`get`](#get) | `POST /suppression/get.json` | Gets a reason and date of email suppression. |
+| [`list`](#list) | `POST /suppression/list.json` | Returns a suppression list since provided date. |
+| [`delete`](#delete) | `POST /suppression/delete.json` | 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. |
+
+## set
+
+`POST /suppression/set.json` · [Documentation](https://docs.unione.io/en/web-api-ref#suppression-set)
+
+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.
+
+### Request: `SuppressionSetRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `email` | `String` | yes | Email to add in suppression list. |
+| `cause` | `String` | yes | Cause of email being suppressed. One of:<br><br>- __unsubscribed__ - email is unsubscribed;<br>- __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.:<br><br>- a previous email has been rejected by the recipient's server for spam;<br>- the recipient's mailbox is full or is not used;<br>- recipient's domain does not accept mail;<br>- sending server was rejected due to blacklisting;<br><br>- __permanent_unavailable__ - the email address is permanently unavailable due to multiple hard bounces;<br>- __complained__ -  the recipient reported spam in the previous emails; |
+| `created` | `String` |  | When suppression was created, in UTC timezone in "YYYY-MM-DD hh:mm:ss" format. |
+
+### Response: `SuccessResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+
+### Example
+
+```ruby
+require 'unione'
+
+Suppression = UniOne::Api::Suppression::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.suppression.set(Suppression::SuppressionSetRequest.new(
+  email: 'email@example.com',
+  cause: 'unsubscribed',
+  created: '2021-12-19 10:15:49'
+))
+p response
+```
+
+## get
+
+`POST /suppression/get.json` · [Documentation](https://docs.unione.io/en/web-api-ref#suppression-get)
+
+Gets a reason and date of email suppression.
+
+### Request: `SuppressionGetRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `email` | `String` | yes | Email to get suppression details for. |
+| `all_projects` | `Boolean` |  | If a user has projects functionality enabled, he/she can pass all_projects=true to search in all projects' data. |
+
+### Response: `SuppressionGetResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `email` | `String` | The email for which suppression details were requested. |
+| `suppressions` | `Array<SuppressionGetObject>` | Array of suppression objects. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Suppression = UniOne::Api::Suppression::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.suppression.get(Suppression::SuppressionGetRequest.new(
+  email: 'email@example.com'
+))
+p response.email
+```
+
+## list
+
+`POST /suppression/list.json` · [Documentation](https://docs.unione.io/en/web-api-ref#suppression-list)
+
+Returns a suppression list since provided date.
+
+### Request: `SuppressionListRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `cause` | `String` |  | Cause of email being suppressed. One of:<br><br>- __unsubscribed__ - email is unsubscribed;<br>- __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.:<br><br>- a previous email has been rejected by the recipient's server for spam;<br>- the recipient's mailbox is full or is not used;<br>- recipient's domain does not accept mail;<br>- sending server was rejected due to blacklisting;<br><br>- __permanent_unavailable__ - the email address is permanently unavailable due to multiple hard bounces;<br>- __complained__ -  the recipient reported spam in the previous emails;<br>- __blocked__ -  sending to the email is prohibited by administration of UniOne.<br>We may add some new causes in the future. |
+| `source` | `String` |  | Source of email being suppressed. One of:<br><br>- __user__ - suppressed by user with    [suppression/set](https://docs.unione.io/en/web-api-ref#suppression-set);<br>- __system__ - sending to the email is prohibited by system, for example due to multiple hard bounces;<br>- __subscriber__ - the recipient reported spam or unsubscribed in the previous emails. |
+| `start_time` | `String` |  | 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. |
+| `cursor` | `String` |  | 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. |
+| `limit` | `Integer` |  | Limits the number of records to be returned at one time, default is 50. |
+
+### Response: `SuppressionListResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `suppressions` | `Array<SuppressionListObject>` | Array of suppression objects. |
+| `cursor` | `String` | 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. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Suppression = UniOne::Api::Suppression::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.suppression.list(Suppression::SuppressionListRequest.new(
+  cause: 'unsubscribed',
+  source: 'user',
+  start_time: '2020-10-14 17:00:00',
+  cursor: 'Ajfb6Hvdkn3hdhhvG57xbdufhG5',
+  limit: 50
+))
+p response.suppressions
+```
+
+## delete
+
+`POST /suppression/delete.json` · [Documentation](https://docs.unione.io/en/web-api-ref#suppression-delete)
+
+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.
+
+### Request: `SuppressionDeleteRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `email` | `String` | yes | An email to delete from suppression list. |
+
+### Response: `SuccessResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+
+### Example
+
+```ruby
+require 'unione'
+
+Suppression = UniOne::Api::Suppression::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.suppression.delete(Suppression::SuppressionDeleteRequest.new(
+  email: 'email@example.com'
+))
+p response
+```

data/docs/System.md

@@ -0,0 +1,73 @@
+# System
+
+[Back to the list of sections](../README.md)
+
+System operations.
+
+`UniOne::Api::System::SystemApi`, `client.system`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`ping`](#ping) | `POST /system/ping.json` | Checks API key validity and returns user ID. |
+| [`info`](#info) | `POST /system/info.json` | Gets user or project info by API key. |
+
+## ping
+
+`POST /system/ping.json` · [Documentation](https://docs.unione.io/en/web-api-ref#system-ping)
+
+Checks API key validity and returns user ID.
+
+### Request
+
+The method has no parameters.
+
+### Response: `SystemPingResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `user_id` | `Integer` | Unique user identifier. |
+
+### Example
+
+```ruby
+require 'unione'
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.system.ping
+p response.user_id
+```
+
+## info
+
+`POST /system/info.json` · [Documentation](https://docs.unione.io/en/web-api-ref#system-info)
+
+Gets user or project info by API key.
+
+### Request
+
+The method has no parameters.
+
+### Response: `SystemInfoResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `user_id` | `Integer` | Unique user identifier. |
+| `email` | `String` | Email of the user. |
+| `project_id` | `String` | Unqiue project identifier, ASCII string up to 36 characters long. Present only if the API key used for request is the project API key. |
+| `project_name` | `String` | Project name, unique for user account. Present only if the API key used for request is the project API key. |
+| `project_accounting` | `ProjectAccountingObject` | Object with email counter properties. Present only if the API key used for request is the user API key. |
+| `accounting` | `SystemInfoResponseAccounting` | Object with accounting period properties. Present only if the API key used for request is the user API key. |
+
+### Example
+
+```ruby
+require 'unione'
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.system.info
+p response.user_id
+```

data/docs/Tag.md

@@ -0,0 +1,73 @@
+# Tag
+
+[Back to the list of sections](../README.md)
+
+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.
+
+`UniOne::Api::Tag::TagApi`, `client.tag`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`list`](#list) | `POST /tag/list.json` | This method returns the full list of user-defined tags. Does not receive any parameters. |
+| [`delete`](#delete) | `POST /tag/delete.json` | Removes tag. |
+
+## list
+
+`POST /tag/list.json` · [Documentation](https://docs.unione.io/en/web-api-ref#tag-list)
+
+This method returns the full list of user-defined tags. Does not receive any parameters.
+
+### Request
+
+The method has no parameters.
+
+### Response: `TagListResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `tags` | `Array<TagsResponseObject>` | An array of objects containing data for user-defined tags. |
+
+### Example
+
+```ruby
+require 'unione'
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.tag.list
+p response.tags
+```
+
+## delete
+
+`POST /tag/delete.json` · [Documentation](https://docs.unione.io/en/web-api-ref#tag-delete)
+
+Removes tag.
+
+### Request: `TagDeleteRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `tag_id` | `Integer` | yes | Unique tag id. |
+
+### Response: `SuccessResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+
+### Example
+
+```ruby
+require 'unione'
+
+Tag = UniOne::Api::Tag::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.tag.delete(Tag::TagDeleteRequest.new(
+  tag_id: 54
+))
+p response
+```