ngrok-api 0.16.0 → 0.17.0

data/lib/ngrokapi/services/edges_tcp_client.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-edges-tcp
+    class EdgesTCPClient
+      # The API path for the requests
+      PATH = '/edges/tcp'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'tcp_edges'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a TCP Edge
+      #
+      # @param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
+      # @param [List<string>] hostports hostports served by this edge
+      # @param [EndpointBackendMutate] backend edge modules
+      # @param [EndpointIPPolicyMutate] ip_restriction
+      # @return [NgrokAPI::Models::TCPEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-create
+      def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil)
+        path = '/edges/tcp'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:hostports] = hostports if hostports
+        data[:backend] = backend if backend
+        data[:ip_restriction] = ip_restriction if ip_restriction
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::TCPEdge.new(client: self, result: result)
+      end
+
+      ##
+      # Get a TCP Edge by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TCPEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-get
+      def get(id: "")
+        path = '/edges/tcp/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::TCPEdge.new(client: self, result: result)
+      end
+
+      ##
+      # Get a TCP Edge by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TCPEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-get
+      def get!(id: "")
+        path = '/edges/tcp/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TCPEdge.new(client: self, result: result)
+      end
+
+      ##
+      # Returns a list of all TCP Edges on this account
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-list
+      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::TCPEdge
+        )
+      end
+
+      ##
+      # Returns a list of all TCP Edges on this account
+      # Throws an exception if API error.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-list
+      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::TCPEdge,
+          danger: true
+        )
+      end
+
+      ##
+      # Updates a TCP 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.
+      #
+      # @param [string] id unique identifier of this edge
+      # @param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
+      # @param [List<string>] hostports hostports served by this edge
+      # @param [EndpointBackendMutate] backend edge modules
+      # @param [EndpointIPPolicyMutate] ip_restriction
+      # @return [NgrokAPI::Models::TCPEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-update
+      def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil)
+        path = '/edges/tcp/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:hostports] = hostports if hostports
+        data[:backend] = backend if backend
+        data[:ip_restriction] = ip_restriction if ip_restriction
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::TCPEdge.new(client: self, result: result)
+      end
+
+      ##
+      # Updates a TCP 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.
+      #
+      # @param [string] id unique identifier of this edge
+      # @param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
+      # @param [List<string>] hostports hostports served by this edge
+      # @param [EndpointBackendMutate] backend edge modules
+      # @param [EndpointIPPolicyMutate] ip_restriction
+      # @return [NgrokAPI::Models::TCPEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-update
+      def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil)
+        path = '/edges/tcp/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:hostports] = hostports if hostports
+        data[:backend] = backend if backend
+        data[:ip_restriction] = ip_restriction if ip_restriction
+        result = @client.patch(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TCPEdge.new(client: self, result: result)
+      end
+
+      ##
+      # Delete a TCP Edge by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-delete
+      def delete(id: "")
+        path = '/edges/tcp/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete a TCP Edge by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-delete
+      def delete!(id: "")
+        path = '/edges/tcp/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/edges_tls_client.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-edges-tls
+    class EdgesTLSClient
+      # The API path for the requests
+      PATH = '/edges/tls'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'tls_edges'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a TLS Edge
+      #
+      # @param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
+      # @param [List<string>] hostports hostports served by this edge
+      # @param [EndpointBackendMutate] backend edge modules
+      # @param [EndpointIPPolicyMutate] ip_restriction
+      # @param [EndpointMutualTLSMutate] mutual_tls
+      # @param [EndpointTLSTermination] tls_termination
+      # @return [NgrokAPI::Models::TLSEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-create
+      def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
+        path = '/edges/tls'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:hostports] = hostports if hostports
+        data[:backend] = backend if backend
+        data[:ip_restriction] = ip_restriction if ip_restriction
+        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::TLSEdge.new(client: self, result: result)
+      end
+
+      ##
+      # Get a TLS Edge by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TLSEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-get
+      def get(id: "")
+        path = '/edges/tls/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::TLSEdge.new(client: self, result: result)
+      end
+
+      ##
+      # Get a TLS Edge by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::TLSEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-get
+      def get!(id: "")
+        path = '/edges/tls/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TLSEdge.new(client: self, result: result)
+      end
+
+      ##
+      # Returns a list of all TLS Edges on this account
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-list
+      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::TLSEdge
+        )
+      end
+
+      ##
+      # Returns a list of all TLS Edges on this account
+      # Throws an exception if API error.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-list
+      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::TLSEdge,
+          danger: true
+        )
+      end
+
+      ##
+      # Updates a TLS 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.
+      #
+      # @param [string] id unique identifier of this edge
+      # @param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
+      # @param [List<string>] hostports hostports served by this edge
+      # @param [EndpointBackendMutate] backend edge modules
+      # @param [EndpointIPPolicyMutate] ip_restriction
+      # @param [EndpointMutualTLSMutate] mutual_tls
+      # @param [EndpointTLSTermination] tls_termination
+      # @return [NgrokAPI::Models::TLSEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-update
+      def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
+        path = '/edges/tls/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:hostports] = hostports if hostports
+        data[:backend] = backend if backend
+        data[:ip_restriction] = ip_restriction if ip_restriction
+        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::TLSEdge.new(client: self, result: result)
+      end
+
+      ##
+      # Updates a TLS 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.
+      #
+      # @param [string] id unique identifier of this edge
+      # @param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
+      # @param [List<string>] hostports hostports served by this edge
+      # @param [EndpointBackendMutate] backend edge modules
+      # @param [EndpointIPPolicyMutate] ip_restriction
+      # @param [EndpointMutualTLSMutate] mutual_tls
+      # @param [EndpointTLSTermination] tls_termination
+      # @return [NgrokAPI::Models::TLSEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-update
+      def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
+        path = '/edges/tls/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:hostports] = hostports if hostports
+        data[:backend] = backend if backend
+        data[:ip_restriction] = ip_restriction if ip_restriction
+        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::TLSEdge.new(client: self, result: result)
+      end
+
+      ##
+      # Delete a TLS Edge by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-delete
+      def delete(id: "")
+        path = '/edges/tls/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete a TLS Edge by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-delete
+      def delete!(id: "")
+        path = '/edges/tls/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/endpoints_client.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # Endpoints provides an API for querying the endpoint objects
+    #  which define what tunnel or edge is used to serve a hostport.
+    #  Only active endpoints associated with a tunnel or backend are returned.
+    #
+    # https://ngrok.com/docs/api#api-endpoints
+    class EndpointsClient
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'endpoints'
+      # The API path for the requests
+      PATH = '/endpoints'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # List all active endpoints on the account
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoints-list
+      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::Endpoint
+        )
+      end
+
+      ##
+      # List all active endpoints on the account
+      # Throws an exception if API error.
+      #
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoints-list
+      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::Endpoint,
+          danger: true
+        )
+      end
+
+      ##
+      # Get the status of an endpoint by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Endpoint] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoints-get
+      def get(id: "")
+        path = '/endpoints/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::Endpoint.new(client: self, result: result)
+      end
+
+      ##
+      # Get the status of an endpoint by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Endpoint] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoints-get
+      def get!(id: "")
+        path = '/endpoints/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::Endpoint.new(client: self, result: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/event_destinations_client.rb

@@ -43,8 +43,7 @@ module NgrokAPI
 
       ##
       # Delete an Event Destination. If the Event Destination is still referenced by an
-      # Event Stream, this will throw an error until that Event Stream has removed that
-      # reference.
+      # Event Subscription.
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
@@ -60,8 +59,7 @@ module NgrokAPI
 
       ##
       # Delete an Event Destination. If the Event Destination is still referenced by an
-      # Event Stream, this will throw an error until that Event Stream has removed that
-      # reference.
+      # Event Subscription.
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier

data/lib/ngrokapi/services/event_subscriptions_client.rb

@@ -22,7 +22,7 @@ module NgrokAPI
       # @param [string] metadata Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
       # @param [string] description Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
       # @param [List<EventSourceReplace>] sources Sources containing the types for which this event subscription will trigger
-      # @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
+      # @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Subscription.
       # @return [NgrokAPI::Models::EventSubscription] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-subscriptions-create
@@ -167,7 +167,7 @@ module NgrokAPI
       # @param [string] metadata Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
       # @param [string] description Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
       # @param [List<EventSourceReplace>] sources Sources containing the types for which this event subscription will trigger
-      # @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
+      # @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Subscription.
       # @return [NgrokAPI::Models::EventSubscription] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-subscriptions-update
@@ -193,7 +193,7 @@ module NgrokAPI
       # @param [string] metadata Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
       # @param [string] description Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
       # @param [List<EventSourceReplace>] sources Sources containing the types for which this event subscription will trigger
-      # @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
+      # @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Subscription.
       # @return [NgrokAPI::Models::EventSubscription] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-subscriptions-update