Class: NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient

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

Overview

ngrok.com/docs/api#api-tcp-edge-ip-restriction-module

Constant Summary collapse

PATH =

The API path for the requests

'/edges/tcp/%{id}/ip_restriction'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ TCPEdgeIPRestrictionModuleClient

Returns a new instance of TCPEdgeIPRestrictionModuleClient.



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

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



13
14
15
 
# File 'lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb', line 13

def client
  @client
end

Instance Method Details

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

ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



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

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

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

ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



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

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

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

ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-get

Parameters:

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

    a resource identifier

Returns:



56
57
58
59
60
61
62
63
64
 
# File 'lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb', line 56

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

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

ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-get

Parameters:

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

    a resource identifier

Returns:



71
72
73
74
75
76
77
78
79
 
# File 'lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb', line 71

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

#replace(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointIPPolicy

ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-replace

Parameters:

  • id (string) (defaults to: "")
  • a_module (EndpointIPPolicyMutate) (defaults to: nil)

Returns:



25
26
27
28
29
30
31
32
33
 
# File 'lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb', line 25

def replace(id: "", a_module: nil)
  path = '/edges/tcp/%{id}/ip_restriction'
  replacements = {
    id: id,
  }
  data = a_module
  result = @client.put(path % replacements, data: data)
  NgrokAPI::Models::EndpointIPPolicy.new(client: self, attrs: result)
end

#replace!(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointIPPolicy

ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-replace

Parameters:

  • id (string) (defaults to: "")
  • a_module (EndpointIPPolicyMutate) (defaults to: nil)

Returns:



41
42
43
44
45
46
47
48
49
 
# File 'lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb', line 41

def replace!(id: "", a_module: nil)
  path = '/edges/tcp/%{id}/ip_restriction'
  replacements = {
    id: id,
  }
  data = a_module
  result = @client.put(path % replacements, data: data, danger: true)
  NgrokAPI::Models::EndpointIPPolicy.new(client: self, attrs: result)
end