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.


1163
1164
1165
# File 'lib/platform-api/client.rb', line 1163

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


1171
1172
1173
# File 'lib/platform-api/client.rb', line 1171

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


1179
1180
1181
# File 'lib/platform-api/client.rb', line 1179

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


1187
1188
1189
# File 'lib/platform-api/client.rb', line 1187

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


1194
1195
1196
# File 'lib/platform-api/client.rb', line 1194

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