Class: NgrokAPI::Services::EdgeRouteSAMLModuleClient

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

Overview

ngrok.com/docs/api#api-edge-route-saml-module

Constant Summary collapse

PATH =

The API path for the requests

'/edges/https/%{edge_id}/routes/%{id}/saml'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ EdgeRouteSAMLModuleClient

Returns a new instance of EdgeRouteSAMLModuleClient.



15
16
17
 
# File 'lib/ngrokapi/services/edge_route_saml_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/edge_route_saml_module_client.rb', line 13

def client
  @client
end

Instance Method Details

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

ngrok.com/docs/api#api-edge-route-saml-module-delete

Parameters:

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

    unique identifier of this edge

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

    unique identifier of this edge route

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



95
96
97
98
99
100
101
102
 
# File 'lib/ngrokapi/services/edge_route_saml_module_client.rb', line 95

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

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

ngrok.com/docs/api#api-edge-route-saml-module-delete

Parameters:

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

    unique identifier of this edge

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

    unique identifier of this edge route

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



110
111
112
113
114
115
116
117
 
# File 'lib/ngrokapi/services/edge_route_saml_module_client.rb', line 110

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

#get(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointSAML

ngrok.com/docs/api#api-edge-route-saml-module-get

Parameters:

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

    unique identifier of this edge

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

    unique identifier of this edge route

Returns:



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

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

#get!(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointSAML

ngrok.com/docs/api#api-edge-route-saml-module-get

Parameters:

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

    unique identifier of this edge

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

    unique identifier of this edge route

Returns:



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

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

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

ngrok.com/docs/api#api-edge-route-saml-module-replace

Parameters:

  • edge_id (string) (defaults to: "")
  • id (string) (defaults to: "")
  • a_module (EndpointSAMLMutate) (defaults to: nil)

Returns:



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/ngrokapi/services/edge_route_saml_module_client.rb', line 26

def replace(edge_id: "", id: "", a_module: nil)
  path = '/edges/https/%{edge_id}/routes/%{id}/saml'
  replacements = {
    edge_id: edge_id,
    id: id,
  }
  data = a_module
  result = @client.put(path % replacements, data: data)
  NgrokAPI::Models::EndpointSAML.new(client: self, attrs: result)
end

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

ngrok.com/docs/api#api-edge-route-saml-module-replace

Parameters:

  • edge_id (string) (defaults to: "")
  • id (string) (defaults to: "")
  • a_module (EndpointSAMLMutate) (defaults to: nil)

Returns:



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/ngrokapi/services/edge_route_saml_module_client.rb', line 44

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