unigo-ruby 1.0.1

data/config/response_schema/unsubscribed.yml

@@ -0,0 +1,45 @@
+unsubscribe:
+  type: object
+  required:
+    - status
+    - address
+    - message
+  properties:
+    status:
+      type: string
+    address:
+      type: string
+    message:
+      type: string
+check_unsubscribed:
+  type: object
+  required:
+    - status
+    - address
+    - is_unsubscribed
+  properties:
+    status:
+      type: string
+    address:
+      type: string
+    is_unsubscribed:
+      type: boolean
+list_unsubscribed:
+  type: object
+  required:
+    - status
+    - unsubscribed
+  properties:
+    status:
+      type: string
+    unsubscribed:
+      items:
+        type: object
+      required:
+        - address
+        - unsubscribed_on
+      properties:
+        address:
+          type: string
+        unsubscribed_on:
+          type: string

data/config/response_schema/webhook.yml

@@ -0,0 +1,141 @@
+set_webhook:
+  type: object
+  required:
+    - status
+    - object
+  properties:
+    status:
+      type: string
+    object:
+      type: object
+      required:
+        - url
+        - status
+        - events
+        - event_format
+        - delivery_info
+        - single_event
+        - max_parallel
+      properties:
+        id:
+          type: integer
+        url:
+          type: string
+        status:
+          type: string
+        event_format:
+          type: string
+        delivery_info:
+          type: integer
+        single_event:
+          type: integer
+        max_parallel:
+          type: integer
+        events:
+          type: object
+          required:
+            - email_status
+            - spam_block
+          properties:
+           email_status:
+             items:
+               type: string
+           spam_block:
+             items:
+               type: string
+get_webhook:
+  type: object
+  required:
+    - status
+    - object
+  properties:
+    status:
+      type: string
+    object:
+      type: object
+      required:
+        - url
+        - status
+        - events
+        - event_format
+        - max_parallel
+      properties:
+        id:
+          type: integer
+        url:
+          type: string
+        status:
+          type: string
+        event_format:
+          type: string
+        max_parallel:
+          type: integer
+        events:
+          type: object
+          required:
+            - email_status
+            - spam_block
+          properties:
+           email_status:
+             items:
+               type: string
+           spam_block:
+             items:
+               type: string
+list_webhooks:
+  type: object
+  required:
+    - status
+    - objects
+  properties:
+    status:
+      type: string
+    objects:
+      items:
+        type: object
+        required:
+          - id
+          - url
+          - status
+          - updated_at
+          - events
+          - event_format
+          - delivery_info
+          - single_event
+          - max_parallel
+        properties:
+           id:
+             type: integer
+           url:
+             type: string
+           status:
+             type: string
+           event_format:
+             type: string
+           delivery_info:
+             type: integer
+           single_event:
+             type: integer
+           max_parallel:
+             type: integer
+           updated_at:
+             type: string
+           events:
+             type: object
+             required:
+               - email_status
+               - spam_block
+             properties:
+               spam_block:
+                 items:
+                   type: string
+               email_status:
+                 items:
+                   type: string
+delete_webhook:
+  type: object
+  required:
+    - status
+  properties:
+    status:
+      type: string

data/examples/api/custom_api.rb

@@ -0,0 +1,14 @@
+require 'unigo-ruby'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Custom Api call
+response =
+  unigo.post(
+    'domain/get-dns-records.json',
+    domain: 'example.com'
+  )

data/examples/api/domain.rb

@@ -0,0 +1,25 @@
+require 'unigo-ruby'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Generate/get DNS records for domain verification and DKIM signing
+response = unigo.get_dns_records(
+  domain: 'example.com'
+)
+
+# Validate domain verification record before use
+response = unigo.validate_verification_record(
+  domain: 'example.com'
+)
+
+# Validate DKIM signature before sending
+response = unigo.validate_dkim(
+  domain: 'example.com'
+)
+
+# Get a list of your domains and their verification/DKIM statuses
+response = unigo.list_domains

data/examples/api/email/attachments.rb

@@ -0,0 +1,28 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Send email with attachments
+message = {}
+
+message[:subject] = 'Subject'
+
+message[:from_email] = 'test@example.net'
+message[:from_name] = 'userName'
+
+message[:body] = { html: '<b>Hello {{substitutionName}}</b>' }
+
+message[:recipients] = []
+message[:recipients] << { email: 'recipient@example.com' }
+
+message[:attachments] = []
+message[:attachments] << { type: 'text/plain', name: 'myfile.txt', content: 'ZXhhbXBsZSBmaWxl' }
+message[:inline_attachments] = []
+message[:inline_attachments] << { type: 'image/png', name: 'IMAGECID', content: 'iVBORw0KGgo' }
+
+response = unigo.send_email(message: message)

data/examples/api/email/multiple_recipients.rb

@@ -0,0 +1,24 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Send email with multiple recipients
+message = {}
+
+message[:subject] = 'Subject'
+
+message[:from_email] = 'test@example.net'
+message[:from_name] = 'userName'
+
+message[:body] = { html: '<b>Hello {{substitutionName}}</b>' }
+
+message[:recipients] = []
+message[:recipients] << { email: 'recipient1@example.com' }
+message[:recipients] << { email: 'recipient2@example.com' }
+
+response = unigo.send_email(message: message)

data/examples/api/email/send.rb

@@ -0,0 +1,25 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+message = {}
+
+message[:subject] = 'Subject'
+
+message[:from_email] = 'test@example.net'
+message[:from_name] = 'userName'
+
+message[:body] = { plaintext: 'Hello' }
+
+# HTML body
+message[:body] = { html: '<b>Hello {{substitutionName}}</b>' }
+
+message[:recipients] = []
+message[:recipients] << { email: 'recipient@example.com' }
+
+response = unigo.send_email(message: message)

data/examples/api/email/settings.rb

@@ -0,0 +1,41 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+message = {}
+
+message[:subject] = 'Subject'
+
+message[:from_email] = 'test@example.net'
+message[:from_name] = 'userName'
+
+message[:body] = { plaintext: 'Hello' }
+
+message[:recipients] = []
+message[:recipients] << { email: 'recipient@example.com' }
+
+message[:global_metadata] = { key: 'val' }
+message[:headers] = { 'X-ReplyTo' => 'reply@example.net' }
+
+message[:track_links] = 1
+message[:track_read] = 1
+
+# Should have permissions to use this option
+message[:skip_unsubscribe] = 1
+
+# Language of the unsubscribe footer and unsubscribe page
+message[:global_language] = 'ru'
+
+message[:options] = {
+  unsubscribe_url: 'https://domain.com/unsubscribe',
+  send_at: Time.now, # Or String: '2021-11-19 10:00:00'
+  custom_backend_id: 1, # Need permission
+  smtp_pool_id: 1       # Need permission
+}
+
+response = unigo.send_email(message: message)

data/examples/api/email/subscribe.rb

@@ -0,0 +1,14 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+response = unigo.subscribe_email(
+  from_email: 'from@example.net',
+  from_name: 'Example Sender',
+  to_email: 'blackhole@example.com'
+)

data/examples/api/email/template.rb

@@ -0,0 +1,26 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Send email using template
+message = {}
+
+message[:subject] = 'Subject'
+
+message[:from_email] = 'test@example.net'
+message[:from_name] = 'userName'
+
+message[:recipients] = []
+message[:recipients] << { email: 'recipient@example.com' }
+
+message[:template_engine] = 'simple'
+message[:template_id] = 'template_id'
+
+message[:tags] = ['string1']
+
+response = unigo.send_email(message: message)

data/examples/api/email.rb

@@ -0,0 +1,51 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(data_center: 'eu1', lang: 'ru', api_key: ENV['UNIGO_API_KEY'])
+
+# sending mail
+mail = UniGo::Mail.new
+
+mail.subject  = 'Email Subject'
+mail.from     = { from_email: 'test@example.net', from_name: 'userName' }
+
+# Using body
+mail.body     = { html: '<b>Hello {{substitutionName}}</b>' }
+
+# Using template
+# mail.template = { template_engine: 'simple', template_id: 'template_id' }
+
+substitutions = { 'substitutionName' => 'substitutionVal', to_name: 'Name Surname 1' }
+recipient1    = { email: 'test1@example.com', substitutions: substitutions, metadata: { key1: 'val1' } }
+mail.recipients << recipient1
+
+substitutions = { 'substitutionName' => 'substitutionVal', to_name: 'Name Surname 2' }
+recipient2    = { email: 'test2@example.com', substitutions: substitutions, metadata: { key1: 'val1' } }
+mail.recipients << recipient2
+
+mail.global_metadata = { key1: 'val1' }
+mail.headers = { 'X-ReplyTo' => 'reply@example.net' }
+mail.track   = { track_links: 1, track_read: 1 }
+mail.options = { unsubscribe_url: 'someurl' }
+
+# Should have rights to use this option
+# mail.skip_unsubscribe = 1
+mail.force_send       = 0
+
+mail.attachments        << { type: 'text/plain', name: 'myfile.txt', content: 'ZXhhbXBsZSBmaWxl' }
+mail.inline_attachments << { type: 'image/png', name: 'IMAGECID', content: 'iVBORw0KGgo' }
+
+puts mail.to_json
+
+response = unigo.send_email(mail.to_json)
+
+puts response.status
+puts response.body
+puts response.headers
+
+# subscribe email
+response = unigo.subscribe_email(
+  from_email: 'from@example.net',
+  from_name: 'Example Sender',
+  to_email: 'blackhole@example.com'
+)

data/examples/api/event_dump.rb

@@ -0,0 +1,44 @@
+require 'unigo-ruby'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Create event dump
+filter = {
+  job_id: '1ZymBc-00041N-9X',
+  status: 'sent',
+  delivery_status: 'err_user_unknown',
+  email: 'david@example.org',
+  email_from: 'sender@example.com',
+  domain: 'example.org',
+  campaign_id: 'c77f4f4e-3561-49f7-9f07-c35be01b4f43'
+}
+
+response = unigo.create_event_dump(
+  start_time: Time.now, # Or String: '2022-07-20 00:00:00'
+  end_time: Time.now, # Or String: '2022-07-21 00:00:00'
+  limit: 50,
+  all_projects: false,
+  filter: filter,
+  delimiter: ';',
+  format: 'csv'
+)
+
+# Get id of created event dump
+dump_id = response.body.dump_id
+
+# Get event dump
+response = unigo.get_event_dump(
+  dump_id: dump_id
+)
+
+# List event dumps
+response = unigo.list_event_dumps
+
+# Delete event dump
+response = unigo.delete_event_dump(
+  dump_id: dump_id
+)

data/examples/api/project.rb

@@ -0,0 +1,44 @@
+require 'unigo-ruby'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Create project
+response = unigo.create_project(
+  project: {
+    name: 'Project Name',
+    country: 'ES',
+    send_enabled: true,
+    custom_unsubscribe_url_enabled: true # Need permission
+  }
+)
+
+# Get id of created project
+project_id = response.body.project_id
+
+# Update project
+response = unigo.update_project(
+  project_id: project_id,
+  project: {
+    name: 'Project Name',
+    country: 'ES',
+    send_enabled: true,
+    custom_unsubscribe_url_enabled: true # Need permission
+  }
+)
+
+# List projects
+response = unigo.list_projects
+
+# List project by id
+response = unigo.list_projects(
+  project_id: project_id
+)
+
+# Delete project
+response = unigo.delete_project(
+  project_id: project_id
+)

data/examples/api/suppression.rb

@@ -0,0 +1,34 @@
+require 'unigo-ruby'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Create suppression
+response = unigo.set_suppression(
+  email: 'user@example.com',
+  cause: 'unsubscribed',
+  created: Time.now, # Or String: '2021-12-19 10:15:49'
+)
+
+# Get suppression
+response = unigo.get_suppression(
+  email: 'user@example.com',
+  all_projects: false
+)
+
+# List suppressions
+response = unigo.list_suppressions(
+  cause: 'unsubscribed',
+  source: 'user',
+  start_time: Time.now, # Or String: '2021-12-19 10:15:49'
+  cursor: 'Ajfb6Hvdkn3hdhhvG57xbdufhG5',
+  limit: 50
+)
+
+# Delete suppression
+response = unigo.delete_suppression(
+  email: 'user@example.com'
+)

data/examples/api/system.rb

@@ -0,0 +1,10 @@
+require 'unigo-ruby'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Get user or project info
+response = unigo.info

data/examples/api/tag.rb

@@ -0,0 +1,15 @@
+require 'unigo-ruby'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# List tags
+response = unigo.list_tags
+
+# Delete tag
+response = unigo.delete_tag(
+  tag_id: tag_id
+)

data/examples/api/template.rb

@@ -0,0 +1,54 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Set template
+template = {}
+
+template[:name] = 'Template Name 1'
+template[:editor_type] = 'html'
+template[:subject] = 'Email Subject'
+template[:template_engine] = 'simple'
+
+template[:global_substitutions] = {
+  'someVar' => 'someVal'
+}
+
+template[:from_email] = 'test@example.com'
+template[:from_name] = 'userName'
+
+template[:headers] = { 'X-ReplyTo' => 'reply@example.com' }
+template[:body] = { html: '<b>Hello {{substitutionName}}</b>' }
+template[:options] = { unsubscribe_url: 'someurl' }
+
+template[:attachments] = []
+template[:attachments] << { type: 'text/plain', name: 'myfile.txt', content: 'ZXhhbXBsZSBmaWxl' }
+
+template[:inline_attachments] = []
+template[:inline_attachments] << { type: 'image/png', name: 'IMAGECID', content: 'iVBORw0KGgo' }
+
+response = unigo.set_template(template: template)
+
+# Get id of created template
+template_id = response.body.template.id
+
+# Get template
+response = unigo.get_template(
+  id: template_id
+)
+
+# List templates
+response = unigo.list_templates(
+  limit: 50,
+  offset: 0
+)
+
+# Delete template
+response = unigo.delete_template(
+  id: template_id
+)

data/examples/api/unsubscribed.rb

@@ -0,0 +1,22 @@
+require 'unigo-ruby'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Unsubscribe email
+response = unigo.unsubscribe(
+  address: 'email@example.com'
+)
+
+# Check email is unsubscribed
+response = unigo.check_unsubscribed(
+  address: 'email@example.com'
+)
+
+# List unsubscribed emails
+response = unigo.list_unsubscribed(
+  date_from: Date.today # Or String: '2019-01-01'
+)