ngrok-api 0.9.0 → 0.16.0

data/lib/ngrokapi/services/abuse_reports_client.rb

@@ -0,0 +1,77 @@
+# 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

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

@@ -1,144 +1,210 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Services
-    ##
-    # A client for interacting with the api_keys API
-    #
-    # https://ngrok.com/docs/api#api-api-keys
-    class ApiKeysClient
-      # The List Property from the resulting API for list calls
-      LIST_PROPERTY = 'keys'
-      # The API path for API keys
-      PATH = '/api_keys'
-
-      attr_reader :client
-
-      def initialize(client:)
-        @client = client
-      end
-
-      # rubocop:disable LineLength
-
-      ##
-      # Create a new API key. The generated API key can be used to authenticate to the ngrok API.
-      #
-      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
-      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
-      # @return [NgrokAPI::Models::ApiKey] result from create request
-      #
-      # https://ngrok.com/docs/api#api-api-keys-create
-      def create(description: nil, metadata: nil)
-        result = @client.post(PATH, data: build_data(description: description, metadata: metadata))
-        NgrokAPI::Models::ApiKey.new(client: self, result: result)
-      end
-      # rubocop:enable LineLength
-
-      ##
-      # Delete an API key by ID.
-      #
-      # @param [string] id a resource identifier
-      # @return [nil] result from delete request
-      #
-      # https://ngrok.com/docs/api#api-api-keys-delete
-      def delete(id: nil)
-        @client.delete("#{PATH}/#{id}")
-      end
-
-      ##
-      # Delete an API key by ID. Throw an exception if 404.
-      #
-      # @param [string] id a resource identifier
-      # @return [nil] result from delete request
-      #
-      # https://ngrok.com/docs/api#api-api-keys-delete
-      def delete!(id: nil)
-        @client.delete("#{PATH}/#{id}", danger: true)
-      end
-
-      ##
-      # Get the details of an API key by ID.
-      #
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::ApiKey] result from get request
-      #
-      # https://ngrok.com/docs/api#api-api-keys-get
-      def get(id: nil)
-        result = @client.get("#{PATH}/#{id}")
-        NgrokAPI::Models::ApiKey.new(client: self, result: result)
-      end
-
-      ##
-      # Get the details of an API key by ID. Throw an exception if 404.
-      #
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::ApiKey] result from get request
-      #
-      # https://ngrok.com/docs/api#api-api-keys-get
-      def get!(id: nil)
-        result = @client.get("#{PATH}/#{id}", danger: true)
-        NgrokAPI::Models::ApiKey.new(client: self, result: result)
-      end
-
-      ##
-      # List all API keys owned by this account.
-      #
-      # @param [string] before_id
-      # @param [integer] limit
-      # @param [string] url optional and mutually exclusive from before_id and limit
-      # @return [NgrokAPI::Models::Listable] the result listable
-      #
-      # https://ngrok.com/docs/api#api-api-keys-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::ApiKey
-        )
-      end
-
-      # rubocop:disable LineLength
-
-      ##
-      # Update attributes of an API key by ID.
-      #
-      # @param [string] id
-      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
-      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
-      # @return [NgrokAPI::Models::ApiKey] result from update request
-      #
-      # https://ngrok.com/docs/api#api-api-keys-update
-      def update(id: nil, description: nil, metadata: nil)
-        result = @client.patch("#{PATH}/#{id}", data: build_data(description: description, metadata: metadata))
-        NgrokAPI::Models::ApiKey.new(client: self, result: result)
-      end
-
-      ##
-      # Update attributes of an API key by ID.
-      #
-      # @param [string] id
-      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
-      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
-      # @return [NgrokAPI::Models::ApiKey] result from update request
-      #
-      # https://ngrok.com/docs/api#api-api-keys-update
-      def update!(id: nil, description: nil, metadata: nil)
-        data = build_data(description: description, metadata: metadata)
-        result = @client.patch("#{PATH}/#{id}", danger: true, data: data)
-        NgrokAPI::Models::ApiKey.new(client: self, result: result)
-      end
-      # rubocop:enable LineLength
-
-      private
-
-      def build_data(description: nil, metadata: nil)
-        data = {}
-        data[:description] = description if description
-        data[:metadata] = metadata if metadata
-        data
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # API Keys are used to authenticate to the [ngrok
+    #  API](https://ngrok.com/docs/api#authentication). You may use the API itself
+    #  to provision and manage API Keys but you'll need to provision your first API
+    #  key from the [API Keys page](https://dashboard.ngrok.com/api/keys) on your
+    #  ngrok.com dashboard.
+    #
+    # https://ngrok.com/docs/api#api-api-keys
+    class APIKeysClient
+      # The API path for the requests
+      PATH = '/api_keys'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'keys'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new API key. The generated API key can be used to authenticate to the
+      # ngrok API.
+      #
+      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
+      # @return [NgrokAPI::Models::APIKey] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-create
+      def create(description: "", metadata: "")
+        path = '/api_keys'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::APIKey.new(client: self, result: result)
+      end
+
+      ##
+      # Delete an API key by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-delete
+      def delete(id: "")
+        path = '/api_keys/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an API key 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-api-keys-delete
+      def delete!(id: "")
+        path = '/api_keys/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get the details of an API key by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::APIKey] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-get
+      def get(id: "")
+        path = '/api_keys/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::APIKey.new(client: self, result: result)
+      end
+
+      ##
+      # Get the details of an API key by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::APIKey] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-api-keys-get
+      def get!(id: "")
+        path = '/api_keys/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::APIKey.new(client: self, result: result)
+      end
+
+      ##
+      # List all API keys 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-api-keys-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::APIKey
+        )
+      end
+
+      ##
+      # List all API keys 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-api-keys-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::APIKey,
+          danger: true
+        )
+      end
+
+      ##
+      # Update attributes of an API key by ID.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
+      # @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)
+        path = '/api_keys/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::APIKey.new(client: self, result: result)
+      end
+
+      ##
+      # Update attributes of an API key by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes
+      # @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)
+        path = '/api_keys/%{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::APIKey.new(client: self, result: result)
+      end
+    end
+  end
+end