Class: NgrokAPI::Services::EdgesHTTPSClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/services/edges_https_client.rb

Overview

https://ngrok.com/docs/api#api-edges-https

Constant Summary collapse

PATH =

The API path for the requests

'/edges/https'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'https_edges'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ EdgesHTTPSClient 



17
18
19
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 17

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



15
16
17
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 15

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::HTTPSEdge

Create an HTTPS Edge

https://ngrok.com/docs/api#api-edges-https-create



32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 32

def create(description: "", metadata: "", hostports: nil, mutual_tls: nil, tls_termination: nil)
  path = '/edges/https'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:mutual_tls] = mutual_tls if mutual_tls
  data[:tls_termination] = tls_termination if tls_termination
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::HTTPSEdge.new(client: self, attrs: result)
end

#create!(description: "", metadata: "", hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::HTTPSEdge

Create an HTTPS Edge Throws an exception if API error.

https://ngrok.com/docs/api#api-edges-https-create



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 58

def create!(description: "", metadata: "", hostports: nil, mutual_tls: nil, tls_termination: nil)
  path = '/edges/https'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:mutual_tls] = mutual_tls if mutual_tls
  data[:tls_termination] = tls_termination if tls_termination
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::HTTPSEdge.new(client: self, attrs: result)
end

#delete(id: "") ⇒ NgrokAPI::Models::Empty

Delete an HTTPS Edge by ID

https://ngrok.com/docs/api#api-edges-https-delete



228
229
230
231
232
233
234
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 228

def delete(id: "")
  path = '/edges/https/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements)
end

#delete!(id: "") ⇒ NgrokAPI::Models::Empty

Delete an HTTPS Edge by ID Throws an exception if API error.

https://ngrok.com/docs/api#api-edges-https-delete



244
245
246
247
248
249
250
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 244

def delete!(id: "")
  path = '/edges/https/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end

#get(id: "") ⇒ NgrokAPI::Models::HTTPSEdge

Get an HTTPS Edge by ID

https://ngrok.com/docs/api#api-edges-https-get



79
80
81
82
83
84
85
86
87
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 79

def get(id: "")
  path = '/edges/https/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::HTTPSEdge.new(client: self, attrs: result)
end

#get!(id: "") ⇒ NgrokAPI::Models::HTTPSEdge

Get an HTTPS Edge by ID Throws an exception if API error.

https://ngrok.com/docs/api#api-edges-https-get



97
98
99
100
101
102
103
104
105
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 97

def get!(id: "")
  path = '/edges/https/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::HTTPSEdge.new(client: self, attrs: result)
end

#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

Returns a list of all HTTPS Edges on this account

https://ngrok.com/docs/api#api-edges-https-list



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 116

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::HTTPSEdge
  )
end

#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

Returns a list of all HTTPS Edges on this account Throws an exception if API error.

https://ngrok.com/docs/api#api-edges-https-list



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 142

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::HTTPSEdge,
    danger: true
  )
end

#update(id: "", description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::HTTPSEdge

Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

https://ngrok.com/docs/api#api-edges-https-update



175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 175

def update(id: "", description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil)
  path = '/edges/https/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:mutual_tls] = mutual_tls if mutual_tls
  data[:tls_termination] = tls_termination if tls_termination
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::HTTPSEdge.new(client: self, attrs: result)
end

#update!(id: "", description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::HTTPSEdge

Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throws an exception if API error.

https://ngrok.com/docs/api#api-edges-https-update



206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/ngrokapi/services/edges_https_client.rb', line 206

def update!(id: "", description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil)
  path = '/edges/https/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:mutual_tls] = mutual_tls if mutual_tls
  data[:tls_termination] = tls_termination if tls_termination
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::HTTPSEdge.new(client: self, attrs: result)
end