class NgrokAPI::Services::EdgeRouteOAuthModuleClient

ngrok.com/docs/api#api-edge-route-o-auth-module

Constants

PATH

The API path for the requests

Attributes

client[R]

Public Class Methods

new(client:) click to toggle source
# File lib/ngrokapi/services/edge_route_o_auth_module_client.rb, line 13
def initialize(client:)
  @client = client
end

Public Instance Methods

delete(edge_id: "", id: "") click to toggle source

@param [string] edge_id unique identifier of this edge @param [string] id unique identifier of this edge route @return [NgrokAPI::Models::Empty] result from the API request

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

# File lib/ngrokapi/services/edge_route_o_auth_module_client.rb, line 93
def delete(edge_id: "", id: "")
  path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
  replacements = {
    edge_id: edge_id,
    id: id,
  }
  @client.delete(path % replacements)
end
delete!(edge_id: "", id: "") click to toggle source

@param [string] edge_id unique identifier of this edge @param [string] id unique identifier of this edge route @return [NgrokAPI::Models::Empty] result from the API request

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

# File lib/ngrokapi/services/edge_route_o_auth_module_client.rb, line 108
def delete!(edge_id: "", id: "")
  path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
  replacements = {
    edge_id: edge_id,
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end
get(edge_id: "", id: "") click to toggle source

@param [string] edge_id unique identifier of this edge @param [string] id unique identifier of this edge route @return [NgrokAPI::Models::EndpointOAuth] result from the API request

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

# File lib/ngrokapi/services/edge_route_o_auth_module_client.rb, line 59
def get(edge_id: "", id: "")
  path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
  replacements = {
    edge_id: edge_id,
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::EndpointOAuth.new(client: self, attrs: result)
end
get!(edge_id: "", id: "") click to toggle source

@param [string] edge_id unique identifier of this edge @param [string] id unique identifier of this edge route @return [NgrokAPI::Models::EndpointOAuth] result from the API request

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

# File lib/ngrokapi/services/edge_route_o_auth_module_client.rb, line 76
def get!(edge_id: "", id: "")
  path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
  replacements = {
    edge_id: edge_id,
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::EndpointOAuth.new(client: self, attrs: result)
end
replace(edge_id: "", id: "", a_module: nil) click to toggle source

@param [string] edge_id @param [string] id @param [EndpointOAuth] a_module @return [NgrokAPI::Models::EndpointOAuth] result from the API request

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

# File lib/ngrokapi/services/edge_route_o_auth_module_client.rb, line 24
def replace(edge_id: "", id: "", a_module: nil)
  path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
  replacements = {
    edge_id: edge_id,
    id: id,
  }
  data = a_module
  result = @client.put(path % replacements, data: data)
  NgrokAPI::Models::EndpointOAuth.new(client: self, attrs: result)
end
replace!(edge_id: "", id: "", a_module: nil) click to toggle source

@param [string] edge_id @param [string] id @param [EndpointOAuth] a_module @return [NgrokAPI::Models::EndpointOAuth] result from the API request

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

# File lib/ngrokapi/services/edge_route_o_auth_module_client.rb, line 42
def replace!(edge_id: "", id: "", a_module: nil)
  path = '/edges/https/%{edge_id}/routes/%{id}/oauth'
  replacements = {
    edge_id: edge_id,
    id: id,
  }
  data = a_module
  result = @client.put(path % replacements, data: data, danger: true)
  NgrokAPI::Models::EndpointOAuth.new(client: self, attrs: result)
end