ngrok-api 0.14.0 → 0.17.0

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

@@ -28,13 +28,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventDestination] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-destinations-create
-      def create(
-        metadata: "",
-        description: "",
-        format: "",
-        target: nil,
-        verify_with_test_event: nil
-      )
+      def create(metadata: "", description: "", format: "", target: nil, verify_with_test_event: nil)
         path = '/event_destinations'
         replacements = {
         }
@@ -49,16 +43,13 @@ 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
       #
       # https://ngrok.com/docs/api#api-event-destinations-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/event_destinations/%{id}'
         replacements = {
           id: id,
@@ -68,17 +59,14 @@ 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
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-destinations-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/event_destinations/%{id}'
         replacements = {
           id: id,
@@ -93,9 +81,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventDestination] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-destinations-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/event_destinations/%{id}'
         replacements = {
           id: id,
@@ -113,9 +99,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventDestination] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-destinations-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/event_destinations/%{id}'
         replacements = {
           id: id,
@@ -134,11 +118,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-destinations-list
-      def list(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      def list(before_id: nil, limit: nil,
+               url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -164,11 +145,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-destinations-list
-      def list!(
-        before_id: nil,
-        limit: nil,
-        url: nil
-      )
+      def list!(before_id: nil, limit: nil,
+                url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -197,14 +175,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventDestination] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-destinations-update
-      def update(
-        id: "",
-        metadata: nil,
-        description: nil,
-        format: nil,
-        target: nil,
-        verify_with_test_event: nil
-      )
+      def update(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil)
         path = '/event_destinations/%{id}'
         replacements = {
           id: id,
@@ -230,14 +201,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventDestination] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-destinations-update
-      def update!(
-        id: "",
-        metadata: nil,
-        description: nil,
-        format: nil,
-        target: nil,
-        verify_with_test_event: nil
-      )
+      def update!(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil)
         path = '/event_destinations/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/event_sources_client.rb

@@ -22,12 +22,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventSource] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-sources-create
-      def create(
-        subscription_id: "",
-        type: "",
-        filter: "",
-        fields: []
-      )
+      def create(subscription_id: "", type: "", filter: "", fields: [])
         path = '/event_subscriptions/%{subscription_id}/sources'
         replacements = {
           subscription_id: subscription_id,
@@ -46,10 +41,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-sources-delete
-      def delete(
-        subscription_id: "",
-        type: ""
-      )
+      def delete(subscription_id: "", type: "")
         path = '/event_subscriptions/%{subscription_id}/sources/%{type}'
         replacements = {
           subscription_id: subscription_id,
@@ -67,10 +59,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-sources-delete
-      def delete!(
-        subscription_id: "",
-        type: ""
-      )
+      def delete!(subscription_id: "", type: "")
         path = '/event_subscriptions/%{subscription_id}/sources/%{type}'
         replacements = {
           subscription_id: subscription_id,
@@ -87,10 +76,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventSource] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-sources-get
-      def get(
-        subscription_id: "",
-        type: ""
-      )
+      def get(subscription_id: "", type: "")
         path = '/event_subscriptions/%{subscription_id}/sources/%{type}'
         replacements = {
           subscription_id: subscription_id,
@@ -110,10 +96,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventSource] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-sources-get
-      def get!(
-        subscription_id: "",
-        type: ""
-      )
+      def get!(subscription_id: "", type: "")
         path = '/event_subscriptions/%{subscription_id}/sources/%{type}'
         replacements = {
           subscription_id: subscription_id,
@@ -131,9 +114,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventSourceList] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-sources-list
-      def list(
-        subscription_id: ""
-      )
+      def list(subscription_id: "")
         path = '/event_subscriptions/%{subscription_id}/sources'
         replacements = {
           subscription_id: subscription_id,
@@ -151,9 +132,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventSourceList] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-sources-list
-      def list!(
-        subscription_id: ""
-      )
+      def list!(subscription_id: "")
         path = '/event_subscriptions/%{subscription_id}/sources'
         replacements = {
           subscription_id: subscription_id,
@@ -171,12 +150,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventSource] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-sources-update
-      def update(
-        subscription_id: "",
-        type: "",
-        filter: nil,
-        fields: nil
-      )
+      def update(subscription_id: "", type: "", filter: nil, fields: nil)
         path = '/event_subscriptions/%{subscription_id}/sources/%{type}'
         replacements = {
           subscription_id: subscription_id,
@@ -196,12 +170,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::EventSource] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-sources-update
-      def update!(
-        subscription_id: "",
-        type: "",
-        filter: nil,
-        fields: nil
-      )
+      def update!(subscription_id: "", type: "", filter: nil, fields: nil)
         path = '/event_subscriptions/%{subscription_id}/sources/%{type}'
         replacements = {
           subscription_id: subscription_id,