ngrok-api 0.9.0 → 0.12.0

data/lib/ngrokapi/models/reserved_domain_cert_policy.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class ReservedDomainCertPolicy
+      attr_reader :client,
+        :result,
+        :authority,
+        :private_key_type
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @authority = @result['authority']
+        @private_key_type = @result['private_key_type']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/reserved_domain_cert_status.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class ReservedDomainCertStatus
+      attr_reader :client,
+        :result,
+        :renews_at,
+        :provisioning_job
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @renews_at = @result['renews_at']
+        @provisioning_job = @result['provisioning_job']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/ssh_certificate_authority.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class SSHCertificateAuthority
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :public_key,
+        :key_type
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @public_key = @result['public_key']
+        @key_type = @result['key_type']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an SSH Certificate Authority
+      #
+      # https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update an SSH Certificate Authority
+      #
+      # https://ngrok.com/docs/api#api-ssh-certificate-authorities-update
+      def update(
+        description: nil,
+        metadata: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/ssh_credential.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class SSHCredential
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :public_key,
+        :acl
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @public_key = @result['public_key']
+        @acl = @result['acl']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an ssh_credential by ID
+      #
+      # https://ngrok.com/docs/api#api-ssh-credentials-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of an ssh_credential by ID
+      #
+      # https://ngrok.com/docs/api#api-ssh-credentials-update
+      def update(
+        description: nil,
+        metadata: nil,
+        acl: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @acl = acl if acl
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          acl: acl
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/ssh_host_certificate.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class SSHHostCertificate
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :public_key,
+        :key_type,
+        :ssh_certificate_authority_id,
+        :principals,
+        :valid_after,
+        :valid_until,
+        :certificate
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @public_key = @result['public_key']
+        @key_type = @result['key_type']
+        @ssh_certificate_authority_id = @result['ssh_certificate_authority_id']
+        @principals = @result['principals']
+        @valid_after = @result['valid_after']
+        @valid_until = @result['valid_until']
+        @certificate = @result['certificate']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an SSH Host Certificate
+      #
+      # https://ngrok.com/docs/api#api-ssh-host-certificates-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update an SSH Host Certificate
+      #
+      # https://ngrok.com/docs/api#api-ssh-host-certificates-update
+      def update(
+        description: nil,
+        metadata: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/ssh_user_certificate.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class SSHUserCertificate
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :public_key,
+        :key_type,
+        :ssh_certificate_authority_id,
+        :principals,
+        :critical_options,
+        :extensions,
+        :valid_after,
+        :valid_until,
+        :certificate
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @public_key = @result['public_key']
+        @key_type = @result['key_type']
+        @ssh_certificate_authority_id = @result['ssh_certificate_authority_id']
+        @principals = @result['principals']
+        @critical_options = @result['critical_options']
+        @extensions = @result['extensions']
+        @valid_after = @result['valid_after']
+        @valid_until = @result['valid_until']
+        @certificate = @result['certificate']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an SSH User Certificate
+      #
+      # https://ngrok.com/docs/api#api-ssh-user-certificates-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update an SSH User Certificate
+      #
+      # https://ngrok.com/docs/api#api-ssh-user-certificates-update
+      def update(
+        description: nil,
+        metadata: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tls_certificate.rb

@@ -1,62 +1,92 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Models
-    ##
-    # A resource representing data from the tls_certificate API
-    class TlsCertificate
-      attr_reader :id,
-        :client,
-        :created_at,
-        :description,
-        :metadata,
-        :result,
-        :uri
-
-      def initialize(client:, result:)
-        @client = client
-        @result = result
-        @created_at = @result['created_at']
-        @id = @result['id']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @uri = @result['uri']
-      end
-
-      def ==(other)
-        @result == other.result
-      end
-
-      def to_s
-        @result.to_s
-      end
-
-      ##
-      # Delete this TLS certificate.
-      #
-      # @return [nil] result from delete request
-      #
-      # https://ngrok.com/docs/api#api-tls-certificates-delete
-      def delete
-        @client.delete(id: @id)
-      end
-
-      # rubocop:disable LineLength
-
-      ##
-      # Update the attributes of this TLS Certificate.
-      #
-      # @param [string] description human-readable description of this TLS certificate. optional, max 255 bytes.
-      # @param [string] metadata arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
-      # @return [NgrokAPI::Models::TlsCertificate] result from update request
-      #
-      # https://ngrok.com/docs/api#api-tls-certificates-update
-      def update(description: nil, metadata: nil)
-        @description = description if description
-        @metadata = metadata if metadata
-        @client.update(id: @id, description: description, metadata: metadata)
-      end
-      # rubocop:enable LineLength
-    end
-  end
-end
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TLSCertificate
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :certificate_pem,
+        :subject_common_name,
+        :subject_alternative_names,
+        :issued_at,
+        :not_before,
+        :not_after,
+        :key_usages,
+        :extended_key_usages,
+        :private_key_type,
+        :issuer_common_name,
+        :serial_number,
+        :subject_organization,
+        :subject_organizational_unit,
+        :subject_locality,
+        :subject_province,
+        :subject_country
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @certificate_pem = @result['certificate_pem']
+        @subject_common_name = @result['subject_common_name']
+        @subject_alternative_names = @result['subject_alternative_names']
+        @issued_at = @result['issued_at']
+        @not_before = @result['not_before']
+        @not_after = @result['not_after']
+        @key_usages = @result['key_usages']
+        @extended_key_usages = @result['extended_key_usages']
+        @private_key_type = @result['private_key_type']
+        @issuer_common_name = @result['issuer_common_name']
+        @serial_number = @result['serial_number']
+        @subject_organization = @result['subject_organization']
+        @subject_organizational_unit = @result['subject_organizational_unit']
+        @subject_locality = @result['subject_locality']
+        @subject_province = @result['subject_province']
+        @subject_country = @result['subject_country']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete a TLS certificate
+      #
+      # https://ngrok.com/docs/api#api-tls-certificates-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of a TLS Certificate by ID
+      #
+      # https://ngrok.com/docs/api#api-tls-certificates-update
+      def update(
+        description: nil,
+        metadata: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tls_certificate_sa_ns.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TLSCertificateSANs
+      attr_reader :client,
+        :result,
+        :dns_names,
+        :ips
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @dns_names = @result['dns_names']
+        @ips = @result['ips']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tunnel.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class Tunnel
+      attr_reader :client,
+        :result,
+        :id,
+        :public_url,
+        :started_at,
+        :metadata,
+        :proto,
+        :region,
+        :tunnel_session
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @public_url = @result['public_url']
+        @started_at = @result['started_at']
+        @metadata = @result['metadata']
+        @proto = @result['proto']
+        @region = @result['region']
+        @tunnel_session = @result['tunnel_session']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tunnel_session.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TunnelSession
+      attr_reader :client,
+        :result,
+        :agent_version,
+        :credential,
+        :id,
+        :ip,
+        :metadata,
+        :os,
+        :region,
+        :started_at,
+        :transport,
+        :uri
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @agent_version = @result['agent_version']
+        @credential = @result['credential']
+        @id = @result['id']
+        @ip = @result['ip']
+        @metadata = @result['metadata']
+        @os = @result['os']
+        @region = @result['region']
+        @started_at = @result['started_at']
+        @transport = @result['transport']
+        @uri = @result['uri']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/abuse_reports_client.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # Abuse Reports allow you to submit take-down requests for URLs hosted by
+    #  ngrok that violate ngrok's terms of service.
+    #
+    # https://ngrok.com/docs/api#api-abuse-reports
+    class AbuseReportsClient
+      # The API path for the requests
+      PATH = '/abuse_reports'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Creates a new abuse report which will be reviewed by our system and abuse
+      # response team. This API is only available to authorized accounts. Contact
+      # abuse@ngrok.com to request access
+      #
+      # @param [List<uri (string)>] urls a list of URLs containing suspected abusive content
+      # @param [string] metadata arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::AbuseReport] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-abuse-reports-create
+      def create(
+        urls:,
+        metadata: ""
+      )
+        path = '/abuse_reports'
+        replacements = {
+        }
+        data = {}
+        data[:urls] = urls if urls
+        data[:metadata] = metadata if metadata
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::AbuseReport.new(client: self, result: result)
+      end
+
+      ##
+      # Get the detailed status of abuse report by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::AbuseReport] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-abuse-reports-get
+      def get(
+        id: ""
+      )
+        path = '/abuse_reports/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::AbuseReport.new(client: self, result: result)
+      end
+
+      ##
+      # Get the detailed status of abuse report by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::AbuseReport] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-abuse-reports-get
+      def get!(
+        id: ""
+      )
+        path = '/abuse_reports/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::AbuseReport.new(client: self, result: result)
+      end
+    end
+  end
+end