Class: NgrokAPI::Services::ReservedAddrsClient

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

Overview

Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.

https://ngrok.com/docs/api#api-reserved-addrs

Constant Summary collapse

PATH =

The API path for the requests

'/reserved_addrs'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'reserved_addrs'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ReservedAddrsClient

Returns a new instance of ReservedAddrsClient.



19
20
21
 
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 19

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



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

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", region: "", endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr

Create a new reserved address.

https://ngrok.com/docs/api#api-reserved-addrs-create

Parameters:

  • description (string) (defaults to: "") —

    human-readable description of what this reserved address will be used for

  • metadata (string) (defaults to: "") —

    arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.

  • region (string) (defaults to: "") —

    reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

  • endpoint_configuration_id (string) (defaults to: nil) —

    ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address

Returns:



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

def create(description: "", metadata: "", region: "", endpoint_configuration_id: nil)
  path = '/reserved_addrs'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:region] = region if region
  data[:endpoint_configuration_id] = endpoint_configuration_id if endpoint_configuration_id
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::ReservedAddr.new(client: self, result: result)
end

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

Delete a reserved address.

https://ngrok.com/docs/api#api-reserved-addrs-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



53
54
55
56
57
58
59
 
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 53

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

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

Delete a reserved address. Throws an exception if API error.

https://ngrok.com/docs/api#api-reserved-addrs-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



69
70
71
72
73
74
75
 
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 69

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

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

Detach the endpoint configuration attached to a reserved address.

https://ngrok.com/docs/api#api-reserved-addrs-delete-endpoint-config

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



221
222
223
224
225
226
227
 
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 221

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

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

Detach the endpoint configuration attached to a reserved address. Throws an exception if API error.

https://ngrok.com/docs/api#api-reserved-addrs-delete-endpoint-config

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



237
238
239
240
241
242
243
 
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 237

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

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

Get the details of a reserved address.

https://ngrok.com/docs/api#api-reserved-addrs-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



84
85
86
87
88
89
90
91
92
 
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 84

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

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

Get the details of a reserved address. Throws an exception if API error.

https://ngrok.com/docs/api#api-reserved-addrs-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



102
103
104
105
106
107
108
109
110
 
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 102

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

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

List all reserved addresses on this account.

https://ngrok.com/docs/api#api-reserved-addrs-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 121

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,
    result: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::ReservedAddr
  )
end

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

List all reserved addresses on this account. Throws an exception if API error.

https://ngrok.com/docs/api#api-reserved-addrs-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 148

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,
    result: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::ReservedAddr,
    danger: true
  )
end

#update(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr

Update the attributes of a reserved address.

https://ngrok.com/docs/api#api-reserved-addrs-update

Parameters:

  • id (string) (defaults to: "")
  • description (string) (defaults to: nil) —

    human-readable description of what this reserved address will be used for

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.

  • endpoint_configuration_id (string) (defaults to: nil) —

    ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address

Returns:



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

def update(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil)
  path = '/reserved_addrs/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:endpoint_configuration_id] = endpoint_configuration_id if endpoint_configuration_id
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::ReservedAddr.new(client: self, result: result)
end

#update!(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr

Update the attributes of a reserved address. Throws an exception if API error.

https://ngrok.com/docs/api#api-reserved-addrs-update

Parameters:

  • id (string) (defaults to: "")
  • description (string) (defaults to: nil) —

    human-readable description of what this reserved address will be used for

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.

  • endpoint_configuration_id (string) (defaults to: nil) —

    ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address

Returns:



201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 201

def update!(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil)
  path = '/reserved_addrs/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:endpoint_configuration_id] = endpoint_configuration_id if endpoint_configuration_id
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::ReservedAddr.new(client: self, result: result)
end