ngrok-api 0.14.0 → 0.17.0

data/lib/ngrokapi/services/agent_ingresses_client.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-agent-ingresses
+    class AgentIngressesClient
+      # The API path for the requests
+      PATH = '/agent_ingresses'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'ingresses'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new Agent Ingress. The ngrok agent can be configured to connect to
+      # ngrok via the new set of addresses on the returned Agent Ingress.
+      #
+      # @param [string] description human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
+      # @param [string] domain the domain that you own to be used as the base domain name to generate regional agent ingress domains.
+      # @return [NgrokAPI::Models::AgentIngress] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-agent-ingresses-create
+      def create(description: "", metadata: "", domain:)
+        path = '/agent_ingresses'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:domain] = domain if domain
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
+      end
+
+      ##
+      # Delete an Agent Ingress by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-agent-ingresses-delete
+      def delete(id: "")
+        path = '/agent_ingresses/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an Agent Ingress 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-agent-ingresses-delete
+      def delete!(id: "")
+        path = '/agent_ingresses/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get the details of an Agent Ingress by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::AgentIngress] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-agent-ingresses-get
+      def get(id: "")
+        path = '/agent_ingresses/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
+      end
+
+      ##
+      # Get the details of an Agent Ingress by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::AgentIngress] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-agent-ingresses-get
+      def get!(id: "")
+        path = '/agent_ingresses/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
+      end
+
+      ##
+      # List all Agent Ingresses owned by 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-agent-ingresses-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::AgentIngress
+        )
+      end
+
+      ##
+      # List all Agent Ingresses owned by 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-agent-ingresses-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::AgentIngress,
+          danger: true
+        )
+      end
+
+      ##
+      # Update attributes of an Agent Ingress by ID.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
+      # @return [NgrokAPI::Models::AgentIngress] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-agent-ingresses-update
+      def update(id: "", description: nil, metadata: nil)
+        path = '/agent_ingresses/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
+      end
+
+      ##
+      # Update attributes of an Agent Ingress by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
+      # @return [NgrokAPI::Models::AgentIngress] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-agent-ingresses-update
+      def update!(id: "", description: nil, metadata: nil)
+        path = '/agent_ingresses/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.patch(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::AgentIngress.new(client: self, result: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/api_keys_client.rb

@@ -31,10 +31,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-create
-      def create(
-        description: "",
-        metadata: ""
-      )
+      def create(description: "", metadata: "")
         path = '/api_keys'
         replacements = {
         }
@@ -52,9 +49,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/api_keys/%{id}'
         replacements = {
           id: id,
@@ -70,9 +65,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/api_keys/%{id}'
         replacements = {
           id: id,
@@ -87,9 +80,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/api_keys/%{id}'
         replacements = {
           id: id,
@@ -107,9 +98,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/api_keys/%{id}'
         replacements = {
           id: id,
@@ -128,11 +117,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-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,
@@ -158,11 +144,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-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,
@@ -189,11 +172,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update(id: "", description: nil, metadata: nil)
         path = '/api_keys/%{id}'
         replacements = {
           id: id,
@@ -215,11 +194,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::APIKey] result from the API request
       #
       # https://ngrok.com/docs/api#api-api-keys-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update!(id: "", description: nil, metadata: nil)
         path = '/api_keys/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/certificate_authorities_client.rb

@@ -31,11 +31,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-create
-      def create(
-        description: "",
-        metadata: "",
-        ca_pem:
-      )
+      def create(description: "", metadata: "", ca_pem:)
         path = '/certificate_authorities'
         replacements = {
         }
@@ -54,9 +50,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -72,9 +66,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -89,9 +81,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -109,9 +99,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -130,11 +118,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-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,
@@ -160,11 +145,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-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,
@@ -191,11 +173,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update(id: "", description: nil, metadata: nil)
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,
@@ -217,11 +195,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
       #
       # https://ngrok.com/docs/api#api-certificate-authorities-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update!(id: "", description: nil, metadata: nil)
         path = '/certificate_authorities/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/credentials_client.rb

@@ -33,11 +33,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Credential] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-create
-      def create(
-        description: "",
-        metadata: "",
-        acl: []
-      )
+      def create(description: "", metadata: "", acl: [])
         path = '/credentials'
         replacements = {
         }
@@ -56,9 +52,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/credentials/%{id}'
         replacements = {
           id: id,
@@ -74,9 +68,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/credentials/%{id}'
         replacements = {
           id: id,
@@ -91,9 +83,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Credential] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/credentials/%{id}'
         replacements = {
           id: id,
@@ -111,9 +101,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Credential] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/credentials/%{id}'
         replacements = {
           id: id,
@@ -132,11 +120,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-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,
@@ -162,11 +147,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-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,
@@ -194,12 +176,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Credential] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil,
-        acl: nil
-      )
+      def update(id: "", description: nil, metadata: nil, acl: nil)
         path = '/credentials/%{id}'
         replacements = {
           id: id,
@@ -223,12 +200,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Credential] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil,
-        acl: nil
-      )
+      def update!(id: "", description: nil, metadata: nil, acl: nil)
         path = '/credentials/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/edge_route_backend_module_client.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-edge-route-backend-module
+    class EdgeRouteBackendModuleClient
+      # The API path for the requests
+      PATH = '/edges/https/%{edge_id}/routes/%{id}/backend'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointBackendMutate] a_module
+      # @return [NgrokAPI::Models::EndpointBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-replace
+      def replace(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] edge_id
+      # @param [string] id
+      # @param [EndpointBackendMutate] a_module
+      # @return [NgrokAPI::Models::EndpointBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-replace
+      def replace!(edge_id: "", id: "", a_module: nil)
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] edge_id unique identifier of this edge
+      # @param [string] id unique identifier of this edge route
+      # @return [NgrokAPI::Models::EndpointBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-get
+      def get(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] edge_id unique identifier of this edge
+      # @param [string] id unique identifier of this edge route
+      # @return [NgrokAPI::Models::EndpointBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-get
+      def get!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointBackend.new(client: self, result: result)
+      end
+
+      ##
+      # @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
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-delete
+      def delete(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # @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
+      #
+      # https://ngrok.com/docs/api#api-edge-route-backend-module-delete
+      def delete!(edge_id: "", id: "")
+        path = '/edges/https/%{edge_id}/routes/%{id}/backend'
+        replacements = {
+          edge_id: edge_id,
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end