unione 1.1.3

data/docs/Domain.md

@@ -0,0 +1,257 @@
+# Domain
+
+[Back to the list of sections](../README.md)
+
+You can use these methods to setup sender domains and check their statuses. They might be useful in case you want to automate adding domains for your own clients.
+
+To add new sender domain thru API you should take following steps:
+- Get DNS records with [domain/get-dns-records](https://docs.unione.io/en/web-api-ref#domain-get-dns-records) method and add them to your DNS provider.
+- Every 5-10 minutes call [domain/list](https://docs.unione.io/en/web-api-ref#domain-list) method for your domain (or several domains) and check verification-record.status and dkim.status in the response. You can call it more often if you like, but please not more than once per minute.
+- If verification-record.status="unconfirmed" then you should call [domain/validate-verification-record](https://docs.unione.io/en/web-api-ref#domain-validate-verification-record) to trigger verification record validation.
+- If dkim.status="inactive" then start DKIM checking by calling [domain/validate-dkim](https://docs.unione.io/en/web-api-ref#domain-validate-dkim) (UniOne itself checks  DKIM every 30 minutes also)
+- When you get verification-record.status="confirmed" and dkim.status="active" for the domain then you can stop checking it's status with domain/list and start using it as a sender domain.
+
+`UniOne::Api::Domain::DomainApi`, `client.domain`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`get_dns_records`](#get_dns_records) | `POST /domain/get-dns-records.json` | Returns info on domain DNS setup for using with UniOne. |
+| [`validate_verification_record`](#validate_verification_record) | `POST /domain/validate-verification-record.json` | Triggers verification record validation for domain. |
+| [`validate_dkim`](#validate_dkim) | `POST /domain/validate-dkim.json` | Validates DKIM record for domain. |
+| [`list`](#list) | `POST /domain/list.json` | Returns a list of all registered domains for user or project, together with statuses of last validations. |
+| [`get_sandbox_domain`](#get_sandbox_domain) | `POST /domain/get-sandbox-domain.json` | Creates a sandbox domain for the account or returns the existing one. |
+| [`delete`](#delete) | `POST /domain/delete.json` | Deletes a domain. Attention: you should use project's API key to delete a project's domain. |
+
+## get_dns_records
+
+`POST /domain/get-dns-records.json` · [Documentation](https://docs.unione.io/en/web-api-ref#domain-get-dns-records)
+
+Returns info on domain DNS setup for using with UniOne.
+
+In order to send emails you have to confirm that you own the domain that you are going to send emails from and setup DKIM signature for the domain. This method allows you to register your domain in UniOne and generate verification record and DKIM key, or return previously generated ones if domain is already registered.
+You should add then DNS records like this to all of the domains you want to confirm:
+
+`@             IN TXT "unione-validate-hash=483bb362ebdbeedd755cfb1d4d661"`
+
+`us._domainkey IN TXT "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDo7"`
+
+`@             IN TXT  "v=spf1 include:spf.unione.io ~all"`
+
+- First record value should contain "verification-record" field returned by get-dns-records method "as is".
+- Second record value should contain "dkim" field value after "p=". Mind the name of this record! "us._domainkey." prefix is important for DKIM selector of UniOne to work properly.
+- Third record contains optional, but very recommended SPF entry. Probably you already have one, then just add append include:spf.unione.io right after v=spf1.
+
+Syntax requirements of different DNS providers may differ:
+- sometimes it's necesarry to put full domain name instead of @ sign.
+- some providers require add TTL value (like 3600)
+- some providers don't require quotes for enclosing values
+Please check requirements of your provider and advice your users to do it.
+
+### Request: `DomainGetDnsRecordsRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `domain` | `String` | yes | Domain to get DNS records for. |
+
+### Response: `DomainGetDnsRecordsResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `domain` | `String` | Domain to get DNS records for. |
+| `verification_record` | `String` | Record to be added "as is" to verify ownership of this domain. |
+| `dkim` | `String` | DKIM signature for the domain. This property contains only the key part, you should prepend it with "v=DKIM1; k=rsa; p=" for the TXT record to be valid. |
+| `dmarc` | `String` | Target of the CNAME record for the "_dmarc" host of the domain. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Domain = UniOne::Api::Domain::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.domain.get_dns_records(Domain::DomainGetDnsRecordsRequest.new(
+  domain: 'example.com'
+))
+p response.domain
+```
+
+## validate_verification_record
+
+`POST /domain/validate-verification-record.json` · [Documentation](https://docs.unione.io/en/web-api-ref#domain-validate-verification-record)
+
+Triggers verification record validation for domain.
+
+If you get 200 OK then it means the validation process started succesfully, but it doesn't mean the verification record is valid. You should check later verification-record.status field returned by [domain/list](https://docs.unione.io/en/web-api-ref#domain-list) method to get the result. Please read more [here](https://docs.unione.io/en/web-api-ref#domain).
+
+### Request: `DomainValidateVerificationRecordRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `domain` | `String` | yes | Domain to validate verification record for. |
+
+### Response: `DomainValidateVerificationRecordResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `message` | `String` | Debug message. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Domain = UniOne::Api::Domain::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.domain.validate_verification_record(Domain::DomainValidateVerificationRecordRequest.new(
+  domain: 'example.com'
+))
+p response.message
+```
+
+## validate_dkim
+
+`POST /domain/validate-dkim.json` · [Documentation](https://docs.unione.io/en/web-api-ref#domain-validate-dkim)
+
+Validates DKIM record for domain.
+
+If you get 200 OK then it means the validation process started succesfully, but it doesn't mean the DKIM record is valid. You should check later dkim.status field returned by [domain/list](https://docs.unione.io/en/web-api-ref#domain-list) method to get the result. Please read more [here](https://docs.unione.io/en/web-api-ref#domain).
+
+### Request: `DomainValidateDkimRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `domain` | `String` | yes | Domain to validate DKIM record for. |
+
+### Response: `DomainValidateDkimResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `message` | `String` | Debug message. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Domain = UniOne::Api::Domain::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.domain.validate_dkim(Domain::DomainValidateDkimRequest.new(
+  domain: 'example.com'
+))
+p response.message
+```
+
+## list
+
+`POST /domain/list.json` · [Documentation](https://docs.unione.io/en/web-api-ref#domain-list)
+
+Returns a list of all registered domains for user or project, together with statuses of last validations.
+
+Returns last status of ownership validation and DKIM validation for each domain. Read more [here](https://docs.unione.io/en/web-api-ref#domain).
+
+### Request: `DomainListRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `domain` | `String` |  | Optional domain name if you want to get the status of single domain only. |
+| `limit` | `Integer` |  | Limits the number of domains returned. Default is 50. |
+| `offset` | `Integer` |  | Index of the first domain in the list, starting with 0. |
+
+### Response: `DomainListResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `domains` | `Array<DomainListResponseDomainsItem>` | Array of objects describing domains. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Domain = UniOne::Api::Domain::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.domain.list(Domain::DomainListRequest.new(
+  domain: 'example.com'
+))
+p response.domains
+```
+
+## get_sandbox_domain
+
+`POST /domain/get-sandbox-domain.json` · [Documentation](https://docs.unione.io/en/web-api-ref#domain-get-sandbox-domain)
+
+Creates a sandbox domain for the account or returns the existing one.
+
+Returns an account sandbox domain that is ready for use in the `from_email` field of [email/send](https://docs.unione.io/en/web-api-ref#email-send). If the account has no sandbox domain, UniOne creates one and returns it. Repeated calls return the same domain.
+
+The method is available only with an account API key. Project API keys cannot create sandbox domains.
+
+### Request
+
+The method has no parameters.
+
+### Response: `DomainGetSandboxDomainResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `domain` | `String` | Sandbox domain name. |
+
+### Example
+
+```ruby
+require 'unione'
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.domain.get_sandbox_domain
+p response.domain
+```
+
+## delete
+
+`POST /domain/delete.json` · [Documentation](https://docs.unione.io/en/web-api-ref#domain-delete)
+
+Deletes a domain. Attention: you should use project's API key to delete a project's domain.
+
+Deletes a domain.
+
+### Request: `DomainDeleteRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `domain` | `String` | yes | Domain name to delete. |
+
+### Response: `DomainDeleteResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `message` | `String` | Domain deleted |
+
+### Example
+
+```ruby
+require 'unione'
+
+Domain = UniOne::Api::Domain::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.domain.delete(Domain::DomainDeleteRequest.new(
+  domain: 'example.com'
+))
+p response.message
+```

data/docs/Email.md

@@ -0,0 +1,126 @@
+# Email
+
+[Back to the list of sections](../README.md)
+
+This group of methods is related with email sending.
+
+`UniOne::Api::Email::EmailApi`, `client.email`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`send_email`](#send_email) | `POST /email/send.json` | Sends an email or a bunch of emails |
+| [`subscribe`](#subscribe) | `POST /email/subscribe.json` | Sends an email with (re)subscribe link. |
+
+## send_email
+
+`POST /email/send.json` · [Documentation](https://docs.unione.io/en/web-api-ref#email-send)
+
+Sends an email or a bunch of emails
+
+While sending you can provide substitutions (merge tags), use a template, turn on read or click tracking, etc.
+
+Restrictions:
+* maximum request size is 10 MB
+* maximum number of recipients is 500
+* The symbol '/' is not allowed in attachment names
+
+If the list of recipients contains invalid, non-existent, duplicate, or unsubscribed emails, those emails will be returned in the output parameter failed_emails, and the email will be sent to all other valid emails addresses. If all the emails addresses fall into failed_emails, sending will not be carried out and API error 204 will be returned.
+
+### Request: `EmailSendRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `message` | `MessageObject` | yes | Object containing all message properties. |
+
+### Response: `EmailSendResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `job_id` | `String` | Job identifier, might be useful for investigating errors. |
+| `emails` | `Array<String>` | Array of recipients emails successfully accepted for sending. |
+| `failed_emails` | `Hash{String => String}` | Object with emails rejected for sending as property names and their statuses as property values, e.g.: {"email1@gmail.com": "temporary_unavailable"}. Possible statuses:<br><br>- __unsubscribed__ - specified email is unsubscribed;<br>- __invalid__ - the email does not exist or has been entered incorrectly;<br>- __duplicate__ - the email already exists in the request, email duplicating is prevented;<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 or unsubscribed globally.<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 added new statuses in the future. |
+
+### Example
+
+```ruby
+require 'unione'
+
+Common = UniOne::Common::Model
+Email = UniOne::Api::Email::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.email.send_email(Email::EmailSendRequest.new(
+  message: Email::MessageObject.new(
+    recipients: [
+      Email::MessageObjectRecipientsItem.new(
+        email: 'user@example.com',
+        substitutions: {
+          'CustomerId' => '12452',
+          'to_name' => 'John Smith',
+        },
+        metadata: {
+          'campaign_id' => 'c77f4f4e-3561-49f7-9f07-c35be01b4f43',
+          'customer_hash' => 'b253ac7',
+        }
+      )
+    ],
+    template_id: '00000000-0000-0000-0000-000000000000',
+    global_language: 'en',
+    template_engine: Common::TemplateEngine::VELOCITY,
+    body: Common::BodyObject.new(
+      html: '<b>Hello, {{to_name}}</b>',
+      plaintext: 'Hello, {{to_name}}',
+      amp: '<!doctype html><html amp4email><head> <meta charset="utf-8"><script async src="https://cdn.ampproject.org/v0.js"></script> <style amp4email-boilerplate>body{visibility:hidden}</style></head><body> Hello, AMP4EMAIL world.</body></html>'
+    ),
+    subject: 'UniOne test email ',
+    from_email: 'email@example.com',
+    from_name: 'John Smith',
+    reply_to: 'email@example.com',
+    reply_to_name: 'John Smith',
+    idempotence_key: 'SG1VsbG68sIH2dvc5mx890kIQ'
+  )
+))
+p response.job_id
+```
+
+## subscribe
+
+`POST /email/subscribe.json` · [Documentation](https://docs.unione.io/en/web-api-ref#email-subscribe)
+
+Sends an email with (re)subscribe link.
+
+This method allows subscription renewal by a former subscriber who has previously unsubscribed, or who is blocked because of complaints. This method sends an email with a new subscription link to a former subscriber. Once the recipient clicks the link, their subscription status is restored.
+There is a default restriction that limits this method to being used once a day. If you need to resubscribe more often, please ask support about it.
+
+### Request: `EmailSubscribeRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `from_email` | `String` | yes | Sender’s email on a confirmed domain. (Field alias "email_address_from" is supported, too). |
+| `from_name` | `String` | yes | Sender’s name. (Field alias "name_from" is supported, too). |
+| `to_email` | `String` | yes | Recipient’s email. (Field alias "email_address_to" is supported, too). |
+
+### Response: `SuccessResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+
+### Example
+
+```ruby
+require 'unione'
+
+Email = UniOne::Api::Email::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.email.subscribe(Email::EmailSubscribeRequest.new(
+  from_email: 'email@example.com',
+  from_name: 'Example',
+  to_email: 'email@example.com'
+))
+p response
+```

data/docs/EmailValidation.md

@@ -0,0 +1,54 @@
+# EmailValidation
+
+[Back to the list of sections](../README.md)
+
+Email validation methods. As a result of the check, you’ll get detailed information on email validity. It will help eliminate nonexistent emails, decrease the number of complaints, clean up the subscribers list and eventually enhance your sender reputation score. For example, you may add validation to a subscription form on your site to let users know they’ve just entered an invalid address.
+
+`UniOne::Api::EmailValidation::EmailValidationApi`, `client.email_validation`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`single`](#single) | `POST /email-validation/single.json` | A maximum of two concurrent requests are allowed; if you send more requests, an error will be returned. Since the verification process should be completed promptly, we've set a time limit on email check. If we encounter a slow email server that does not respond in 5 seconds, you may get an “unknown” status. |
+
+## single
+
+`POST /email-validation/single.json` · [Documentation](https://docs.unione.io/en/web-api-ref#email-validation-single)
+
+A maximum of two concurrent requests are allowed; if you send more requests, an error will be returned. Since the verification process should be completed promptly, we've set a time limit on email check. If we encounter a slow email server that does not respond in 5 seconds, you may get an “unknown” status.
+
+### Request: `EmailValidationSingleRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `email` | `String` | yes | Email address to be checked. |
+
+### Response: `EmailValidationSingleResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `email` | `String` | Email address to be checked. |
+| `result` | `String` | Possible statuses:<br><br>- "valid" - the address is valid,<br>- "invalid" - the address is invalid,<br>- "suspicious" - the address looks suspicious,<br>- "unknown" - could not perform validation, the domain’s mail server has not responded within the time limit. |
+| `cause` | `String` | Possible statuses:<br><br>- "no_mx_record" - no MX record found for the target domain,<br>- "syntax_error" - the address syntax is invalid,<br>- "possible_typo" - the address is likely to have a typo,<br>- "mailbox_not_found" - the address does not exist,<br>- "global_suppression" - the address has been marked as unreachable due to multiple previous delivery errors,<br>- "disposable" - this is a disposable one-time email address which is usually valid for a few minutes only,<br>- "role" - the address is not likely to belong to an actual person, but rather to a certain business staff role,<br>- "abuse" - the address is known to be a source of a large number of complaints, sometimes issued automatically,<br>- "spamtrap" - this email is a spam trap, it is published openly but never used for actual emails. Sending messages to such addresses has a huge negative impact on reputation score,<br>- "smtp_connection_failed" - the domain’s SMTP server does not respond; the address may contain a typo. |
+| `validity` | `Integer` | Validity score, from 0 to 100 (0 – invalid, 100 – valid). |
+| `local_part` | `String` | Local part (everything preceding the @ sign). |
+| `domain` | `String` | Domain name part. |
+| `mx_found` | `Boolean` | True if the address’ domain does have an MX record, false if does not. |
+| `mx_record` | `String` | Preferred MX record for the domain. |
+| `did_you_mean` | `String` | For addresses which are likely to have typing errors (cause=possible_typo), a suggested variant with a fixed typo. |
+| `processed_at` | `String` | Email check date and time, YYYY-MM-DD hh:mm:ss UTC. |
+
+### Example
+
+```ruby
+require 'unione'
+
+EmailValidation = UniOne::Api::EmailValidation::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.email_validation.single(EmailValidation::EmailValidationSingleRequest.new(
+  email: 'email@example.com'
+))
+p response.email
+```

data/docs/EventDump.md

@@ -0,0 +1,157 @@
+# EventDump
+
+[Back to the list of sections](../README.md)
+
+These methods are used to obtain a list of events for a given period of time. The data is stored for up to 45 days, depending on your tariff, i. e. you may fetch all event data starting from 00:00:00 31 days ago and up to current time. For custom tarifs with big sending volumes event dumps are available only for the last 7 days.
+
+`UniOne::Api::EventDump::EventDumpApi`, `client.event_dump`
+
+| Method | Endpoint | Description |
+|---|---|---|
+| [`create`](#create) | `POST /event-dump/create.json` | This asynchronous method initiates the preparation of data dump in CSV format. The number of dump files created or stored is limited to 10; to order more files, you have to delete one of the previous ones or wait until they will be deleted automatically. A newly created dump file is kept for 8 hours. If the request period is more than a day or there are too many events then several files will be generated and each file will contain no more than 100,000 events. File contains columns with the following information - 'event_time', 'job_id', 'from_email', 'email', 'status', 'delivery_status', 'metadata', 'destination_response', 'user_agent', 'url', 'ip', 'tags' and 'project_id' (for accounts with projects enabled). You can change the fields and include 'subject' field using 'dump_fileds' parameter. |
+| [`get`](#get) | `POST /event-dump/get.json` | Returns dump properties for a given identifier |
+| [`list`](#list) | `POST /event-dump/list.json` | This method does not require any parameters; returns the full list of existing dumps. |
+| [`delete`](#delete) | `POST /event-dump/delete.json` | Removes dump from queue or storage. |
+
+## create
+
+`POST /event-dump/create.json` · [Documentation](https://docs.unione.io/en/web-api-ref#event-dump-create)
+
+This asynchronous method initiates the preparation of data dump in CSV format. The number of dump files created or stored is limited to 10; to order more files, you have to delete one of the previous ones or wait until they will be deleted automatically. A newly created dump file is kept for 8 hours. If the request period is more than a day or there are too many events then several files will be generated and each file will contain no more than 100,000 events. File contains columns with the following information - 'event_time', 'job_id', 'from_email', 'email', 'status', 'delivery_status', 'metadata', 'destination_response', 'user_agent', 'url', 'ip', 'tags' and 'project_id' (for accounts with projects enabled). You can change the fields and include 'subject' field using 'dump_fileds' parameter.
+
+### Request: `EventDumpCreateRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `start_time` | `String` | yes | Date and time in YYYY-MM-DD hh:mm:ss format, specifying period start time. Data is stored for up to 32 days, depending on your tariff. |
+| `end_time` | `String` |  | Date and time in YYYY-MM-DD hh:mm:ss format, specifying period end time (non-inclusive). |
+| `limit` | `Integer` |  | Maximum number of events returned (default is 50). If this value is over 100 000, several files will be created, each having 100 000 events maximum. |
+| `all_projects` | `Boolean` |  | For accounts with projects enabled, the value all_projects=true allows to fetch data for all existing projects. |
+| `filter` | `FilterObject` |  | An object with the properties of the event dump filter. |
+| `dump_fields` | `Array<String>` |  | An array of strings containing the names of columns you need in your report, in your preferred order. If the 'dump_fields' array is missing or empty, a default field list and order will be applied. Allowed values, in their default order, are - 'project_id', 'event_time', 'job_id', 'from_email', 'email', 'status', 'delivery_status', 'metadata', 'destination_response', 'user_agent', 'url', 'ip', 'tags'. For maximum security, the 'subject' field is not included by default, but you can add it by explicitly including in the 'dump_fields' array. |
+| `aggregate` | `String` |  | Allows you to obtain aggregated statistics for a given time period. The two allowed values are:<br><br>- __day_status__ - fetch aggregated statistics (the filter value must be missing or empty, as filters are not allowed with this option);<br>- __an empty string__ - used by default, event_dump/create works as if the aggregate parameter is omitted. |
+| `delimiter` | `String` |  | Field delimiter, can be set to either  ',' or ';', defaults to  ','. |
+| `format` | `String` |  | File format, either “csv” (default) or “csv_gzip”. |
+
+### Response: `EventDumpCreateResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `dump_id` | `String` | Dump identifier, used to call the [event-dump/get](https://docs.unione.io/en/web-api-ref#event-dump-get) method. |
+
+### Example
+
+```ruby
+require 'unione'
+
+EventDump = UniOne::Api::EventDump::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.event_dump.create(EventDump::EventDumpCreateRequest.new(
+  start_time: '2022-07-20 00:00:00',
+  end_time: '2022-07-21 00:00:00',
+  limit: 50,
+  dump_fields: ['string1'],
+  aggregate: 'day_status',
+  delimiter: ';',
+  format: 'csv'
+))
+p response.dump_id
+```
+
+## get
+
+`POST /event-dump/get.json` · [Documentation](https://docs.unione.io/en/web-api-ref#event-dump-get)
+
+Returns dump properties for a given identifier
+
+### Request: `EventDumpGetRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `dump_id` | `String` | yes | Dump identifier received by the method [event-dump/create](https://docs.unione.io/en/web-api-ref#event-dump-create). |
+
+### Response: `EventDumpGetResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `event_dump` | `EventDumpObject` | An object with the properties of the event dump. |
+
+### Example
+
+```ruby
+require 'unione'
+
+EventDump = UniOne::Api::EventDump::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.event_dump.get(EventDump::EventDumpGetRequest.new(
+  dump_id: 'Gqfasjh34tlasd'
+))
+p response.event_dump
+```
+
+## list
+
+`POST /event-dump/list.json` · [Documentation](https://docs.unione.io/en/web-api-ref#event-dump-list)
+
+This method does not require any parameters; returns the full list of existing dumps.
+
+### Request
+
+The method has no parameters.
+
+### Response: `EventDumpListResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+| `event_dumps` | `Array<EventDumpObject>` | An array of objects describing event dumps. Each object is similar to 'event_dump' object returned by the [event-dump/get](https://docs.unione.io/en/web-api-ref#event-dump-get) method. |
+
+### Example
+
+```ruby
+require 'unione'
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.event_dump.list
+p response.event_dumps
+```
+
+## delete
+
+`POST /event-dump/delete.json` · [Documentation](https://docs.unione.io/en/web-api-ref#event-dump-delete)
+
+Removes dump from queue or storage.
+
+### Request: `EventDumpDeleteRequest`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `dump_id` | `String` | yes | Dump identifier, obtained via the [event-dump/create](https://docs.unione.io/en/web-api-ref#event-dump-create) method. |
+
+### Response: `SuccessResponse`
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | `String` | "success" string (`success`) |
+
+### Example
+
+```ruby
+require 'unione'
+
+EventDump = UniOne::Api::EventDump::Model
+
+client = UniOne.client('YOUR_API_KEY')
+
+response = client.event_dump.delete(EventDump::EventDumpDeleteRequest.new(
+  dump_id: 'Gqfasjh34tlasd'
+))
+p response
+```