Class: NgrokAPI::Services::ReservedDomainsClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::ReservedDomainsClient
- Defined in:
- lib/ngrokapi/services/reserved_domains_client.rb
Overview
Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.
Constant Summary collapse
- PATH =
The API path for the requests
'/reserved_domains'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'reserved_domains'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain
Create a new reserved domain.
-
#create!(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain
Create a new reserved domain.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete a reserved domain.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete a reserved domain.
-
#delete_certificate(id: "") ⇒ NgrokAPI::Models::Empty
Detach the certificate attached to a reserved domain.
-
#delete_certificate!(id: "") ⇒ NgrokAPI::Models::Empty
Detach the certificate attached to a reserved domain.
-
#delete_certificate_management_policy(id: "") ⇒ NgrokAPI::Models::Empty
Detach the certificate management policy attached to a reserved domain.
-
#delete_certificate_management_policy!(id: "") ⇒ NgrokAPI::Models::Empty
Detach the certificate management policy attached to a reserved domain.
-
#get(id: "") ⇒ NgrokAPI::Models::ReservedDomain
Get the details of a reserved domain.
-
#get!(id: "") ⇒ NgrokAPI::Models::ReservedDomain
Get the details of a reserved domain.
-
#initialize(client:) ⇒ ReservedDomainsClient
constructor
A new instance of ReservedDomainsClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all reserved domains on this account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all reserved domains on this account.
-
#update(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain
Update the attributes of a reserved domain.
-
#update!(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain
Update the attributes of a reserved domain.
Constructor Details
#initialize(client:) ⇒ ReservedDomainsClient
Returns a new instance of ReservedDomainsClient.
20 21 22 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 20 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
18 19 20 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 18 def client @client end |
Instance Method Details
#create(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain
Create a new reserved domain.
36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 36 def create(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) path = '/reserved_domains' replacements = { } data = {} data[:name] = name if name data[:region] = region if region data[:description] = description if description data[:metadata] = if data[:certificate_id] = certificate_id if certificate_id data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy result = @client.post(path % replacements, data: data) NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result) end |
#create!(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain
Create a new reserved domain. Throws an exception if API error.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 64 def create!(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) path = '/reserved_domains' replacements = { } data = {} data[:name] = name if name data[:region] = region if region data[:description] = description if description data[:metadata] = if data[:certificate_id] = certificate_id if certificate_id data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete a reserved domain.
86 87 88 89 90 91 92 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 86 def delete(id: "") path = '/reserved_domains/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete a reserved domain. Throws an exception if API error.
102 103 104 105 106 107 108 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 102 def delete!(id: "") path = '/reserved_domains/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#delete_certificate(id: "") ⇒ NgrokAPI::Models::Empty
Detach the certificate attached to a reserved domain.
287 288 289 290 291 292 293 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 287 def delete_certificate(id: "") path = '/reserved_domains/%{id}/certificate' replacements = { id: id, } @client.delete(path % replacements) end |
#delete_certificate!(id: "") ⇒ NgrokAPI::Models::Empty
Detach the certificate attached to a reserved domain. Throws an exception if API error.
303 304 305 306 307 308 309 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 303 def delete_certificate!(id: "") path = '/reserved_domains/%{id}/certificate' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#delete_certificate_management_policy(id: "") ⇒ NgrokAPI::Models::Empty
Detach the certificate management policy attached to a reserved domain.
ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy
256 257 258 259 260 261 262 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 256 def delete_certificate_management_policy(id: "") path = '/reserved_domains/%{id}/certificate_management_policy' replacements = { id: id, } @client.delete(path % replacements) end |
#delete_certificate_management_policy!(id: "") ⇒ NgrokAPI::Models::Empty
Detach the certificate management policy attached to a reserved domain. Throws an exception if API error.
ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy
272 273 274 275 276 277 278 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 272 def delete_certificate_management_policy!(id: "") path = '/reserved_domains/%{id}/certificate_management_policy' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::ReservedDomain
Get the details of a reserved domain.
117 118 119 120 121 122 123 124 125 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 117 def get(id: "") path = '/reserved_domains/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::ReservedDomain
Get the details of a reserved domain. Throws an exception if API error.
135 136 137 138 139 140 141 142 143 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 135 def get!(id: "") path = '/reserved_domains/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all reserved domains on this account.
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 154 def list(before_id: nil, limit: nil, url: nil) result = @client.list( before_id: before_id, limit: limit, url: url, path: PATH ) NgrokAPI::Models::Listable.new( client: self, attrs: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::ReservedDomain ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all reserved domains on this account. Throws an exception if API error.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 180 def list!(before_id: nil, limit: nil, url: nil) result = @client.list( before_id: before_id, limit: limit, danger: true, url: url, path: PATH ) NgrokAPI::Models::Listable.new( client: self, attrs: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::ReservedDomain, danger: true ) end |
#update(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain
Update the attributes of a reserved domain.
209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 209 def update(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) path = '/reserved_domains/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if data[:certificate_id] = certificate_id if certificate_id data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy result = @client.patch(path % replacements, data: data) NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result) end |
#update!(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain
Update the attributes of a reserved domain. Throws an exception if API error.
235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/ngrokapi/services/reserved_domains_client.rb', line 235 def update!(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) path = '/reserved_domains/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if data[:certificate_id] = certificate_id if certificate_id data[:certificate_management_policy] = certificate_management_policy if certificate_management_policy result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::ReservedDomain.new(client: self, attrs: result) end |