ngrok-api 0.9.0 → 0.16.0

data/lib/ngrokapi/services/certificate_authorities_client.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # Certificate Authorities are x509 certificates that are used to sign other
+    #  x509 certificates. Attach a Certificate Authority to the Mutual TLS module
+    #  to verify that the TLS certificate presented by a client has been signed by
+    #  this CA. Certificate Authorities  are used only for mTLS validation only and
+    #  thus a private key is not included in the resource.
+    #
+    # https://ngrok.com/docs/api#api-certificate-authorities
+    class CertificateAuthoritiesClient
+      # The API path for the requests
+      PATH = '/certificate_authorities'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'certificate_authorities'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Upload a new Certificate Authority
+      #
+      # @param [string] description human-readable description of this Certificate Authority. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
+      # @param [string] ca_pem raw PEM of the Certificate Authority
+      # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-certificate-authorities-create
+      def create(description: "", metadata: "", ca_pem:)
+        path = '/certificate_authorities'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:ca_pem] = ca_pem if ca_pem
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::CertificateAuthority.new(client: self, result: result)
+      end
+
+      ##
+      # Delete a Certificate Authority
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-certificate-authorities-delete
+      def delete(id: "")
+        path = '/certificate_authorities/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete a Certificate Authority
+      # 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-certificate-authorities-delete
+      def delete!(id: "")
+        path = '/certificate_authorities/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about a certficate authority
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-certificate-authorities-get
+      def get(id: "")
+        path = '/certificate_authorities/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::CertificateAuthority.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about a certficate authority
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-certificate-authorities-get
+      def get!(id: "")
+        path = '/certificate_authorities/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::CertificateAuthority.new(client: self, result: result)
+      end
+
+      ##
+      # List all Certificate Authority 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-certificate-authorities-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::CertificateAuthority
+        )
+      end
+
+      ##
+      # List all Certificate Authority 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-certificate-authorities-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::CertificateAuthority,
+          danger: true
+        )
+      end
+
+      ##
+      # Update attributes of a Certificate Authority by ID
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this Certificate Authority. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
+      # @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)
+        path = '/certificate_authorities/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::CertificateAuthority.new(client: self, result: result)
+      end
+
+      ##
+      # Update attributes of a Certificate Authority by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this Certificate Authority. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
+      # @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)
+        path = '/certificate_authorities/%{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::CertificateAuthority.new(client: self, result: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/credentials_client.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
+    #  agent to connect the ngrok service as your account. They are installed with
+    #  the `ngrok authtoken` command or by specifying it in the `ngrok.yml`
+    #  configuration file with the `authtoken` property.
+    #
+    # https://ngrok.com/docs/api#api-credentials
+    class CredentialsClient
+      # The API path for the requests
+      PATH = '/credentials'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'credentials'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new tunnel authtoken credential. This authtoken credential can be used
+      # to start a new tunnel session. The response to this API call is the only time
+      # the generated token is available. If you need it for future use, you must save
+      # it securely yourself.
+      #
+      # @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
+      # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
+      # @return [NgrokAPI::Models::Credential] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-credentials-create
+      def create(description: "", metadata: "", acl: [])
+        path = '/credentials'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:acl] = acl if acl
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::Credential.new(client: self, result: result)
+      end
+
+      ##
+      # Delete a tunnel authtoken credential by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-credentials-delete
+      def delete(id: "")
+        path = '/credentials/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete a tunnel authtoken credential 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-credentials-delete
+      def delete!(id: "")
+        path = '/credentials/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about a tunnel authtoken credential
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Credential] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-credentials-get
+      def get(id: "")
+        path = '/credentials/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::Credential.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about a tunnel authtoken credential
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Credential] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-credentials-get
+      def get!(id: "")
+        path = '/credentials/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::Credential.new(client: self, result: result)
+      end
+
+      ##
+      # List all tunnel authtoken credentials 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-credentials-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::Credential
+        )
+      end
+
+      ##
+      # List all tunnel authtoken credentials 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-credentials-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::Credential,
+          danger: true
+        )
+      end
+
+      ##
+      # Update attributes of an tunnel authtoken credential by ID
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
+      # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
+      # @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)
+        path = '/credentials/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:acl] = acl if acl
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::Credential.new(client: self, result: result)
+      end
+
+      ##
+      # Update attributes of an tunnel authtoken credential by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
+      # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
+      # @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)
+        path = '/credentials/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:acl] = acl if acl
+        result = @client.patch(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::Credential.new(client: self, result: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module
+    class EndpointCircuitBreakerModuleClient
+      # The API path for the requests
+      PATH = '/endpoint_configurations/%{id}/circuit_breaker'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] id
+      # @param [EndpointCircuitBreaker] a_module
+      # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-replace
+      def replace(id: "", a_module: nil)
+        path = '/endpoint_configurations/%{id}/circuit_breaker'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointCircuitBreaker.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id
+      # @param [EndpointCircuitBreaker] a_module
+      # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-replace
+      def replace!(id: "", a_module: nil)
+        path = '/endpoint_configurations/%{id}/circuit_breaker'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointCircuitBreaker.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-get
+      def get(id: "")
+        path = '/endpoint_configurations/%{id}/circuit_breaker'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointCircuitBreaker.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointCircuitBreaker] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-get
+      def get!(id: "")
+        path = '/endpoint_configurations/%{id}/circuit_breaker'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointCircuitBreaker.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-delete
+      def delete(id: "")
+        path = '/endpoint_configurations/%{id}/circuit_breaker'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-delete
+      def delete!(id: "")
+        path = '/endpoint_configurations/%{id}/circuit_breaker'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/endpoint_compression_module_client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-endpoint-compression-module
+    class EndpointCompressionModuleClient
+      # The API path for the requests
+      PATH = '/endpoint_configurations/%{id}/compression'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] id
+      # @param [EndpointCompression] a_module
+      # @return [NgrokAPI::Models::EndpointCompression] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-compression-module-replace
+      def replace(id: "", a_module: nil)
+        path = '/endpoint_configurations/%{id}/compression'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointCompression.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id
+      # @param [EndpointCompression] a_module
+      # @return [NgrokAPI::Models::EndpointCompression] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-compression-module-replace
+      def replace!(id: "", a_module: nil)
+        path = '/endpoint_configurations/%{id}/compression'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointCompression.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointCompression] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-compression-module-get
+      def get(id: "")
+        path = '/endpoint_configurations/%{id}/compression'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointCompression.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointCompression] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-compression-module-get
+      def get!(id: "")
+        path = '/endpoint_configurations/%{id}/compression'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointCompression.new(client: self, result: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-compression-module-delete
+      def delete(id: "")
+        path = '/endpoint_configurations/%{id}/compression'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-compression-module-delete
+      def delete!(id: "")
+        path = '/endpoint_configurations/%{id}/compression'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end