ngrok-api 0.9.0 → 0.12.0

data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # An SSH Certificate Authority is a pair of an SSH Certificate and its private
+    #  key that can be used to sign other SSH host and user certificates.
+    #
+    # https://ngrok.com/docs/api#api-ssh-certificate-authorities
+    class SSHCertificateAuthoritiesClient
+      # The API path for the requests
+      PATH = '/ssh_certificate_authorities'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'ssh_certificate_authorities'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new SSH Certificate Authority
+      #
+      # @param [string] description human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
+      # @param [string] private_key_type the type of private key to generate. one of ``rsa``, ``ecdsa``, ``ed25519``
+      # @param [string] elliptic_curve the type of elliptic curve to use when creating an ECDSA key
+      # @param [int64] key_size the key size to use when creating an RSA key. one of ``2048`` or ``4096``
+      # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-certificate-authorities-create
+      def create(
+        description: "",
+        metadata: "",
+        private_key_type: "",
+        elliptic_curve: "",
+        key_size: 0
+      )
+        path = '/ssh_certificate_authorities'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:private_key_type] = private_key_type if private_key_type
+        data[:elliptic_curve] = elliptic_curve if elliptic_curve
+        data[:key_size] = key_size if key_size
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::SSHCertificateAuthority.new(client: self, result: result)
+      end
+
+      ##
+      # Delete an SSH Certificate Authority
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete
+      def delete(
+        id: ""
+      )
+        path = '/ssh_certificate_authorities/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an SSH 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-ssh-certificate-authorities-delete
+      def delete!(
+        id: ""
+      )
+        path = '/ssh_certificate_authorities/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about an SSH Certficate Authority
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-certificate-authorities-get
+      def get(
+        id: ""
+      )
+        path = '/ssh_certificate_authorities/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::SSHCertificateAuthority.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about an SSH Certficate Authority
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-certificate-authorities-get
+      def get!(
+        id: ""
+      )
+        path = '/ssh_certificate_authorities/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::SSHCertificateAuthority.new(client: self, result: result)
+      end
+
+      ##
+      # List all SSH Certificate Authorities 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-ssh-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::SSHCertificateAuthority
+        )
+      end
+
+      ##
+      # Update an SSH Certificate Authority
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-certificate-authorities-update
+      def update(
+        id: "",
+        description: nil,
+        metadata: nil
+      )
+        path = '/ssh_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::SSHCertificateAuthority.new(client: self, result: result)
+      end
+
+      ##
+      # Update an SSH Certificate Authority
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-certificate-authorities-update
+      def update!(
+        id: "",
+        description: nil,
+        metadata: nil
+      )
+        path = '/ssh_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::SSHCertificateAuthority.new(client: self, result: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/ssh_credentials_client.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # SSH Credentials are SSH public keys that can be used to start SSH tunnels
+    #  via the ngrok SSH tunnel gateway.
+    #
+    # https://ngrok.com/docs/api#api-ssh-credentials
+    class SSHCredentialsClient
+      # The API path for the requests
+      PATH = '/ssh_credentials'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'ssh_credentials'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new ssh_credential from an uploaded public SSH key. This ssh credential
+      # can be used to start new tunnels via ngrok's SSH gateway.
+      #
+      # @param [string] description human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this ssh 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.
+      # @param [string] public_key the PEM-encoded public key of the SSH keypair that will be used to authenticate
+      # @return [NgrokAPI::Models::SSHCredential] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-credentials-create
+      def create(
+        description: "",
+        metadata: "",
+        acl: [],
+        public_key:
+      )
+        path = '/ssh_credentials'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:acl] = acl if acl
+        data[:public_key] = public_key if public_key
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::SSHCredential.new(client: self, result: result)
+      end
+
+      ##
+      # Delete an ssh_credential by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-credentials-delete
+      def delete(
+        id: ""
+      )
+        path = '/ssh_credentials/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an ssh_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-ssh-credentials-delete
+      def delete!(
+        id: ""
+      )
+        path = '/ssh_credentials/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about an ssh_credential
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::SSHCredential] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-credentials-get
+      def get(
+        id: ""
+      )
+        path = '/ssh_credentials/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::SSHCredential.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about an ssh_credential
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::SSHCredential] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-credentials-get
+      def get!(
+        id: ""
+      )
+        path = '/ssh_credentials/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::SSHCredential.new(client: self, result: result)
+      end
+
+      ##
+      # List all ssh 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-ssh-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::SSHCredential
+        )
+      end
+
+      ##
+      # Update attributes of an ssh_credential by ID
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this ssh 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::SSHCredential] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-credentials-update
+      def update(
+        id: "",
+        description: nil,
+        metadata: nil,
+        acl: nil
+      )
+        path = '/ssh_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::SSHCredential.new(client: self, result: result)
+      end
+
+      ##
+      # Update attributes of an ssh_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 ssh credential to authenticate. Optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this ssh 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::SSHCredential] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-credentials-update
+      def update!(
+        id: "",
+        description: nil,
+        metadata: nil,
+        acl: nil
+      )
+        path = '/ssh_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::SSHCredential.new(client: self, result: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/ssh_host_certificates_client.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # SSH Host Certificates along with the corresponding private key allows an SSH
+    #  server to assert its authenticity to connecting SSH clients who trust the
+    #  SSH Certificate Authority that was used to sign the certificate.
+    #
+    # https://ngrok.com/docs/api#api-ssh-host-certificates
+    class SSHHostCertificatesClient
+      # The API path for the requests
+      PATH = '/ssh_host_certificates'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'ssh_host_certificates'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new SSH Host Certificate
+      #
+      # @param [string] ssh_certificate_authority_id the ssh certificate authority that is used to sign this ssh host certificate
+      # @param [string] public_key a public key in OpenSSH Authorized Keys format that this certificate signs
+      # @param [List<string>] principals the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.
+      # @param [datetime (RFC3339 string)] valid_after The time when the host certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.
+      # @param [datetime (RFC3339 string)] valid_until The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this ``valid_before``.
+      # @param [string] description human-readable description of this SSH Host Certificate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-host-certificates-create
+      def create(
+        ssh_certificate_authority_id:,
+        public_key:,
+        principals: [],
+        valid_after: "",
+        valid_until: "",
+        description: "",
+        metadata: ""
+      )
+        path = '/ssh_host_certificates'
+        replacements = {
+        }
+        data = {}
+        data[:ssh_certificate_authority_id] = ssh_certificate_authority_id if ssh_certificate_authority_id
+        data[:public_key] = public_key if public_key
+        data[:principals] = principals if principals
+        data[:valid_after] = valid_after if valid_after
+        data[:valid_until] = valid_until if valid_until
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::SSHHostCertificate.new(client: self, result: result)
+      end
+
+      ##
+      # Delete an SSH Host Certificate
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-host-certificates-delete
+      def delete(
+        id: ""
+      )
+        path = '/ssh_host_certificates/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an SSH Host Certificate
+      # 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-ssh-host-certificates-delete
+      def delete!(
+        id: ""
+      )
+        path = '/ssh_host_certificates/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about an SSH Host Certficate
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-host-certificates-get
+      def get(
+        id: ""
+      )
+        path = '/ssh_host_certificates/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::SSHHostCertificate.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about an SSH Host Certficate
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-host-certificates-get
+      def get!(
+        id: ""
+      )
+        path = '/ssh_host_certificates/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::SSHHostCertificate.new(client: self, result: result)
+      end
+
+      ##
+      # List all SSH Host Certificates issued 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-ssh-host-certificates-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::SSHHostCertificate
+        )
+      end
+
+      ##
+      # Update an SSH Host Certificate
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this SSH Host Certificate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-host-certificates-update
+      def update(
+        id: "",
+        description: nil,
+        metadata: nil
+      )
+        path = '/ssh_host_certificates/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::SSHHostCertificate.new(client: self, result: result)
+      end
+
+      ##
+      # Update an SSH Host Certificate
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of this SSH Host Certificate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ssh-host-certificates-update
+      def update!(
+        id: "",
+        description: nil,
+        metadata: nil
+      )
+        path = '/ssh_host_certificates/%{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::SSHHostCertificate.new(client: self, result: result)
+      end
+    end
+  end
+end