Whitelabel links

Links

#get_wl_links

List all Links

links = client.get_wl_links
links.each do |link|
  puts link.id         # => 1
  puts link.domain     # => 'example.com'
  puts link.subdomain  # => 'mail'
  puts link.username   # => 'john@example.com'
  puts link.user_id    # => 7
  puts link.default    # => true/false
  puts link.valid      # => true/false
  puts link.legacy     # => true/false

  puts link.dns.domain_cname.host  # => 'mail.example.com'
  puts link.dns.domain_cname.type  # => 'cname'
  puts link.dns.domain_cname.data  # => 'sendgrid.net'
  puts link.dns.domain_cname.valid # => true/false

  puts link.dns.owner_cname.host   # => '7.example.com'
  puts link.dns.owner_cname.type   # => 'cname'
  puts link.dns.owner_cname.data   # => 'sendgrid.net'
  puts link.dns.owner_cname.valid  # => true/false
end

#post_wl_link

Create a Link

link = client.post_wl_link(domain: 'example.com', subdomain: 'mail')
puts link.id         # => 1
puts link.domain     # => 'example.com'
puts link.subdomain  # => 'mail'
puts link.username   # => 'john@example.com'
puts link.user_id    # => 7
puts link.default    # => true/false
puts link.valid      # => true/false
puts link.legacy     # => true/false

puts link.dns.domain_cname.host  # => 'mail.example.com'
puts link.dns.domain_cname.type  # => 'cname'
puts link.dns.domain_cname.data  # => 'sendgrid.net'
puts link.dns.domain_cname.valid # => true/false

puts link.dns.owner_cname.host   # => '7.example.com'
puts link.dns.owner_cname.type   # => 'cname'
puts link.dns.owner_cname.data   # => 'sendgrid.net'
puts link.dns.owner_cname.valid  # => true/false

#get_wl_link

Retrieve a Link

link = client.get_wl_link(id: 1)
puts link.id         # => 1
puts link.domain     # => 'example.com'
puts link.subdomain  # => 'mail'
puts link.username   # => 'john@example.com'
puts link.user_id    # => 7
puts link.default    # => true/false
puts link.valid      # => true/false
puts link.legacy     # => true/false

puts link.dns.domain_cname.host  # => 'mail.example.com'
puts link.dns.domain_cname.type  # => 'cname'
puts link.dns.domain_cname.data  # => 'sendgrid.net'
puts link.dns.domain_cname.valid # => true/false

puts link.dns.owner_cname.host   # => '7.example.com'
puts link.dns.owner_cname.type   # => 'cname'
puts link.dns.owner_cname.data   # => 'sendgrid.net'
puts link.dns.owner_cname.valid  # => true/false

#patch_wl_link

Update a Link

link = client.patch_wl_link(id: 1, default: true)
puts link.id         # => 1
puts link.domain     # => 'example.com'
puts link.subdomain  # => 'mail'
puts link.username   # => 'john@example.com'
puts link.user_id    # => 7
puts link.default    # => true/false
puts link.valid      # => true/false
puts link.legacy     # => true/false

puts link.dns.domain_cname.host  # => 'mail.example.com'
puts link.dns.domain_cname.type  # => 'cname'
puts link.dns.domain_cname.data  # => 'sendgrid.net'
puts link.dns.domain_cname.valid # => true/false

puts link.dns.owner_cname.host   # => '7.example.com'
puts link.dns.owner_cname.type   # => 'cname'
puts link.dns.owner_cname.data   # => 'sendgrid.net'
puts link.dns.owner_cname.valid  # => true/false

#delete_wl_link

Delete a Link

client.delete_wl_link(id: 1)

#get_default_wl_link

Default Link

link = client.get_default_wl_link(domain: 'example.com')
puts link.id         # => 1
puts link.domain     # => 'example.com'
puts link.subdomain  # => 'mail'
puts link.username   # => 'john@example.com'
puts link.user_id    # => 7
puts link.default    # => true/false
puts link.valid      # => true/false
puts link.legacy     # => true/false

puts link.dns.domain_cname.host  # => 'mail.example.com'
puts link.dns.domain_cname.type  # => 'cname'
puts link.dns.domain_cname.data  # => 'sendgrid.net'
puts link.dns.domain_cname.valid # => true/false

puts link.dns.owner_cname.host   # => '7.example.com'
puts link.dns.owner_cname.type   # => 'cname'
puts link.dns.owner_cname.data   # => 'sendgrid.net'
puts link.dns.owner_cname.valid  # => true/false

#validate_link

Validate a Link

result = client.validate_wl_link(id: 1)
puts result.id     # => 1,
puts result.valid  #{ => true/false
puts result.validation_results.domain_cname.valid  # => true/false,
puts result.validation_results.domain_cname.reason # => String
puts result.validation_results.owner_cname.valid   # => true/false
puts result.validation_results.owner_cname.reason  # => String

#get_associated_wl_link

List Associated Link

link = client.get_associated_wl_link(username: 'subusername')
puts link.id         # => 1
puts link.domain     # => 'example.com'
puts link.subdomain  # => 'mail'
puts link.username   # => 'usbusername'
puts link.user_id    # => 7
puts link.default    # => true/false
puts link.valid      # => true/false
puts link.legacy     # => true/false

puts link.dns.domain_cname.host  # => 'mail.example.com'
puts link.dns.domain_cname.type  # => 'cname'
puts link.dns.domain_cname.data  # => 'sendgrid.net'
puts link.dns.domain_cname.valid # => true/false

puts link.dns.owner_cname.host   # => '7.example.com'
puts link.dns.owner_cname.type   # => 'cname'
puts link.dns.owner_cname.data   # => 'sendgrid.net'
puts link.dns.owner_cname.valid  # => true/false

#disassociate_wl_link

Disassociate Link

client.disassociate_wl_link(username: 'subusername')

#associate_wl_link

Associate Link

link = client.associate_wl_link(id: 1, username: 'subusername')
puts link.id         # => 1
puts link.domain     # => 'example.com'
puts link.subdomain  # => 'mail'
puts link.username   # => 'subusername'
puts link.user_id    # => 7
puts link.default    # => true/false
puts link.valid      # => true/false
puts link.legacy     # => true/false

puts link.dns.domain_cname.host  # => 'mail.example.com'
puts link.dns.domain_cname.type  # => 'cname'
puts link.dns.domain_cname.data  # => 'sendgrid.net'
puts link.dns.domain_cname.valid # => true/false

puts link.dns.owner_cname.host   # => '7.example.com'
puts link.dns.owner_cname.type   # => 'cname'
puts link.dns.owner_cname.data   # => 'sendgrid.net'
puts link.dns.owner_cname.valid  # => true/false