Class: PlatformAPI::Domain

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

Domains define what web routes should be routed to an app on Heroku.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Domain

Returns a new instance of Domain.



1666
1667
1668
# File 'lib/platform-api/client.rb', line 1666

def initialize(client)
  @client = client
end

Instance Method Details

#create(app_id_or_app_name, body = {}) ⇒ Object

Create a new domain.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app

  • body:

    the object to pass as the request payload



1674
1675
1676
# File 'lib/platform-api/client.rb', line 1674

def create(app_id_or_app_name, body = {})
  @client.domain.create(app_id_or_app_name, body)
end

#delete(app_id_or_app_name, domain_id_or_domain_hostname) ⇒ Object

Delete an existing domain

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app

  • domain_id_or_domain_hostname:

    unique identifier of this domain or full hostname



1691
1692
1693
# File 'lib/platform-api/client.rb', line 1691

def delete(app_id_or_app_name, domain_id_or_domain_hostname)
  @client.domain.delete(app_id_or_app_name, domain_id_or_domain_hostname)
end

#info(app_id_or_app_name, domain_id_or_domain_hostname) ⇒ Object

Info for existing domain.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app

  • domain_id_or_domain_hostname:

    unique identifier of this domain or full hostname



1699
1700
1701
# File 'lib/platform-api/client.rb', line 1699

def info(app_id_or_app_name, domain_id_or_domain_hostname)
  @client.domain.info(app_id_or_app_name, domain_id_or_domain_hostname)
end

#list(app_id_or_app_name) ⇒ Object

List existing domains.

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app



1706
1707
1708
# File 'lib/platform-api/client.rb', line 1706

def list(app_id_or_app_name)
  @client.domain.list(app_id_or_app_name)
end

#update(app_id_or_app_name, domain_id_or_domain_hostname, body = {}) ⇒ Object

Associate an SNI endpoint

Parameters:

  • app_id_or_app_name:

    unique identifier of app or unique name of app

  • domain_id_or_domain_hostname:

    unique identifier of this domain or full hostname

  • body:

    the object to pass as the request payload



1683
1684
1685
# File 'lib/platform-api/client.rb', line 1683

def update(app_id_or_app_name, domain_id_or_domain_hostname, body = {})
  @client.domain.update(app_id_or_app_name, domain_id_or_domain_hostname, body)
end