ngrok-api 0.9.0

data/lib/ngrokapi/services/endpoint_configurations_client.rb

@@ -0,0 +1,313 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # A client for interacting with the endpoint_configuration API
+    #
+    # https://ngrok.com/docs/api#api-endpoint-configurations
+    class EndpointConfigurationsClient
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'endpoint_configurations'
+      # The API path for endpoint configurations
+      PATH = '/endpoint_configurations'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      # rubocop:disable LineLength
+
+      ##
+      # Create a new endpoint configuration
+      #
+      # @param [string] description human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
+      # @param [string] metadata arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
+      # @param [string] type they type of traffic this endpoint configuration can be applied to. one of: ``http``, ``https``, ``tcp``
+      # @param [string] circuit_breaker circuit breaker module configuration
+      # @param [string] compression compression module configuration
+      # @param [string] request_headers request headers module configuration
+      # @param [string] response_headers response headers module configuration
+      # @param [string] ip_policy ip policy module configuration
+      # @param [string] mutual_tls mutual TLS module configuration
+      # @param [string] tls_termination TLS termination module configuration
+      # @param [string] webhook_validation webhook validation module configuration
+      # @param [string] oauth oauth module configuration
+      # @param [string] logging logging module configuration
+      # @param [string] saml saml module configuration
+      # @param [string] oidc oidc module configuration
+      # @return [NgrokAPI::Models::EndpointConfiguration] result from create request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-configurations-create
+      def create(
+        description: '',
+        metadata: '',
+        type: '',
+        circuit_breaker: nil,
+        compression: nil,
+        request_headers: nil,
+        response_headers: nil,
+        ip_policy: nil,
+        mutual_tls: nil,
+        tls_termination: nil,
+        webhook_validation: nil,
+        oauth: nil,
+        logging: nil,
+        saml: nil,
+        oidc: nil
+      )
+        data = {
+          type: type,
+          description: description,
+          metadata: metadata,
+          circuit_breaker: circuit_breaker,
+          compression: compression,
+          request_headers: request_headers,
+          response_headers: response_headers,
+          ip_policy: ip_policy,
+          mutual_tls: mutual_tls,
+          tls_termination: tls_termination,
+          webhook_validation: webhook_validation,
+          oauth: oauth,
+          logging: logging,
+          saml: saml,
+          oidc: oidc,
+        }
+        result = @client.post(PATH, data: data)
+        NgrokAPI::Models::EndpointConfiguration.new(client: self, result: result)
+      end
+      # rubocop:enable LineLength
+
+      ##
+      # Delete an endpoint configuration.
+      # This operation will fail if the endpoint configuration is still referenced by
+      # any reserved domain or reserved address.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-configurations-delete
+      def delete(id: nil)
+        @client.delete("#{PATH}/#{id}")
+      end
+
+      ##
+      # Delete an endpoint configuration. Throw an exception if 404.
+      # This operation will fail if the endpoint configuration is still referenced by
+      # any reserved domain or reserved address.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-configurations-delete
+      def delete!(id: nil)
+        @client.delete("#{PATH}/#{id}", danger: true)
+      end
+
+      ##
+      # Returns detailed information about an endpoint configuration by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointConfiguration] result from get request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-configurations-get
+      def get(id: nil)
+        result = @client.get("#{PATH}/#{id}")
+        NgrokAPI::Models::EndpointConfiguration.new(client: self, result: result)
+      end
+
+      ##
+      # Returns detailed information about an endpoint configuration by ID. Throw an execption if 404.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointConfiguration] result from get request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-configurations-get
+      def get!(id: nil)
+        result = @client.get("#{PATH}/#{id}", danger: true)
+        NgrokAPI::Models::EndpointConfiguration.new(client: self, result: result)
+      end
+
+      ##
+      # Returns a list of all endpoint configurations on 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-endpoint-configurations-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::EndpointConfiguration
+        )
+      end
+
+      # rubocop:disable LineLength
+
+      ##
+      # Updates an endpoint configuration. If a module is not specified in the update, it will not be modified.
+      # However, each module configuration that is specified will completely replace the existing value.
+      # There is no way to delete an existing module via this API, instead use the delete module API.
+      #
+      # @param [string] id unique identifier of this endpoint configuration
+      # @param [string] description human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
+      # @param [string] metadata arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
+      # @param [string] circuit_breaker circuit breaker module configuration
+      # @param [string] compression compression module configuration
+      # @param [string] request_headers request headers module configuration
+      # @param [string] response_headers response headers module configuration
+      # @param [string] ip_policy ip policy module configuration
+      # @param [string] mutual_tls mutual TLS module configuration
+      # @param [string] tls_termination TLS termination module configuration
+      # @param [string] webhook_validation webhook validation module configuration
+      # @param [string] oauth oauth module configuration
+      # @param [string] logging logging module configuration
+      # @param [string] saml saml module configuration
+      # @param [string] oidc oidc module configuration
+      # @return [NgrokAPI::Models::EndpointConfiguration] result from update request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-configurations-update
+      def update(
+        id: nil,
+        description: nil,
+        metadata: nil,
+        circuit_breaker: nil,
+        compression: nil,
+        request_headers: nil,
+        response_headers: nil,
+        ip_policy: nil,
+        mutual_tls: nil,
+        tls_termination: nil,
+        webhook_validation: nil,
+        oauth: nil,
+        logging: nil,
+        saml: nil,
+        oidc: nil
+      )
+        data = build_data(
+          description: description,
+          metadata: metadata,
+          circuit_breaker: circuit_breaker,
+          compression: compression,
+          request_headers: request_headers,
+          response_headers: response_headers,
+          ip_policy: ip_policy,
+          mutual_tls: mutual_tls,
+          tls_termination: tls_termination,
+          webhook_validation: webhook_validation,
+          oauth: oauth,
+          logging: logging,
+          saml: saml,
+          oidc: oidc
+        )
+        result = @client.patch("#{PATH}/#{id}", data: data)
+        NgrokAPI::Models::EndpointConfiguration.new(client: self, result: result)
+      end
+
+      ##
+      # Updates an endpoint configuration. If a module is not specified in the update, it will not be modified.
+      # However, each module configuration that is specified will completely replace the existing value.
+      # There is no way to delete an existing module via this API, instead use the delete module API.
+      # Throw an exception if 404.
+      #
+      # @param [string] id unique identifier of this endpoint configuration
+      # @param [string] description human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
+      # @param [string] metadata arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
+      # @param [string] circuit_breaker circuit breaker module configuration
+      # @param [string] compression compression module configuration
+      # @param [string] request_headers request headers module configuration
+      # @param [string] response_headers response headers module configuration
+      # @param [string] ip_policy ip policy module configuration
+      # @param [string] mutual_tls mutual TLS module configuration
+      # @param [string] tls_termination TLS termination module configuration
+      # @param [string] webhook_validation webhook validation module configuration
+      # @param [string] oauth oauth module configuration
+      # @param [string] logging logging module configuration
+      # @param [string] saml saml module configuration
+      # @param [string] oidc oidc module configuration
+      # @return [NgrokAPI::Models::EndpointConfiguration] result from update request
+      #
+      # https://ngrok.com/docs/api#api-endpoint-configurations-update
+      def update!(
+        id: nil,
+        description: nil,
+        metadata: nil,
+        circuit_breaker: nil,
+        compression: nil,
+        request_headers: nil,
+        response_headers: nil,
+        ip_policy: nil,
+        mutual_tls: nil,
+        tls_termination: nil,
+        webhook_validation: nil,
+        oauth: nil,
+        logging: nil,
+        saml: nil,
+        oidc: nil
+      )
+        data = build_data(
+          description: description,
+          metadata: metadata,
+          circuit_breaker: circuit_breaker,
+          compression: compression,
+          request_headers: request_headers,
+          response_headers: response_headers,
+          ip_policy: ip_policy,
+          mutual_tls: mutual_tls,
+          tls_termination: tls_termination,
+          webhook_validation: webhook_validation,
+          oauth: oauth,
+          logging: logging,
+          saml: saml,
+          oidc: oidc
+        )
+        result = @client.patch("#{PATH}/#{id}", danger: true, data: data)
+        NgrokAPI::Models::EndpointConfiguration.new(client: self, result: result)
+      end
+      # rubocop:enable LineLength
+
+      private
+
+      def build_data(
+        description: nil,
+        metadata: nil,
+        circuit_breaker: nil,
+        compression: nil,
+        request_headers: nil,
+        response_headers: nil,
+        ip_policy: nil,
+        mutual_tls: nil,
+        tls_termination: nil,
+        webhook_validation: nil,
+        oauth: nil,
+        logging: nil,
+        saml: nil,
+        oidc: nil
+      )
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:circuit_breaker] = circuit_breaker if circuit_breaker
+        data[:compression] = compression if compression
+        data[:request_headers] = request_headers if request_headers
+        data[:response_headers] = response_headers if response_headers
+        data[:ip_policy] = ip_policy if ip_policy
+        data[:mutual_tls] = mutual_tls if mutual_tls
+        data[:tls_termination] = tls_termination if tls_termination
+        data[:webhook_validation] = webhook_validation if webhook_validation
+        data[:oauth] = oauth if oauth
+        data[:logging] = logging if logging
+        data[:saml] = saml if saml
+        data[:oidc] = oidc if oidc
+        data
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/reserved_domains_client.rb

@@ -0,0 +1,313 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # A client for interacting with the reserved_domains API
+    #
+    # https://ngrok.com/docs/api#api-reserved-domains
+    class ReservedDomainsClient
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'reserved_domains'
+      # The API path for reserved domains
+      PATH = '/reserved_domains'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      # rubocop:disable LineLength
+
+      ##
+      # Create a new reserved domain.
+      #
+      # @param [string] name the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
+      # @param [string] region reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
+      # @param [string] description human-readable description of what this reserved domain will be used for
+      # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
+      # @param [string] http_endpoint_configuration_id ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
+      # @param [string] https_endpoint_configuration_id ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
+      # @param [string] certificate_id ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
+      # @param [string] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with ``certificate_id``.
+      # @return [NgrokAPI::Models::ReservedDomain] result from create request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-create
+      def create(
+        name: '',
+        region: '',
+        description: '',
+        metadata: '',
+        http_endpoint_configuration_id: '',
+        https_endpoint_configuration_id: '',
+        certificate_id: nil,
+        certificate_management_policy: nil
+      )
+        data = {
+          name: name,
+          region: region,
+          description: description,
+          metadata: metadata,
+          http_endpoint_configuration_id: http_endpoint_configuration_id,
+          https_endpoint_configuration_id: https_endpoint_configuration_id,
+          certificate_id: certificate_id,
+          certificate_management_policy: certificate_management_policy,
+        }
+        result = @client.post(PATH, data: data)
+        NgrokAPI::Models::ReservedDomain.new(client: self, result: result)
+      end
+      # rubocop:enable LineLength
+
+      ##
+      # Delete a reserved domain.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete
+      def delete(id: nil)
+        @client.delete("#{PATH}/#{id}")
+      end
+
+      ##
+      # Delete a reserved domain. Throw an exception if 404.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete
+      def delete!(id: nil)
+        @client.delete("#{PATH}/#{id}", danger: true)
+      end
+
+      ##
+      # Get the details of a reserved domain.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::ReservedDomain] result from get request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-get
+      def get(id: nil)
+        result = @client.get("#{PATH}/#{id}")
+        NgrokAPI::Models::ReservedDomain.new(client: self, result: result)
+      end
+
+      ##
+      # Get the details of a reserved domain. Throw an exception if 404.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::ReservedDomain] result from get request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-get
+      def get!(id: nil)
+        result = @client.get!("#{PATH}/#{id}")
+        NgrokAPI::Models::ReservedDomain.new(client: self, result: result)
+      end
+
+      ##
+      # List all reserved domains on 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] result from list request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-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::ReservedDomain
+        )
+      end
+
+      # rubocop:disable LineLength
+
+      ##
+      # Update the attributes of a reserved domain.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of what this reserved domain will be used for
+      # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
+      # @param [string] http_endpoint_configuration_id ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
+      # @param [string] https_endpoint_configuration_id ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
+      # @param [string] certificate_id ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
+      # @param [string] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with ``certificate_id``.
+      # @return [NgrokAPI::Models::ReservedDomain] result from update request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-update
+      def update(
+        id: nil,
+        certificate_id: nil,
+        certificate_management_policy: nil,
+        description: nil,
+        http_endpoint_configuration_id: nil,
+        https_endpoint_configuration_id: nil,
+        metadata: nil
+      )
+        data = build_data(
+          description: description,
+          metadata: metadata,
+          http_endpoint_configuration_id: http_endpoint_configuration_id,
+          https_endpoint_configuration_id: https_endpoint_configuration_id,
+          certificate_id: certificate_id,
+          certificate_management_policy: certificate_management_policy
+        )
+        result = @client.patch("#{PATH}/#{id}", data: data)
+        NgrokAPI::Models::ReservedDomain.new(client: self, result: result)
+      end
+
+      ##
+      # Update the attributes of a reserved domain. Throw an exception if 404.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of what this reserved domain will be used for
+      # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
+      # @param [string] http_endpoint_configuration_id ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
+      # @param [string] https_endpoint_configuration_id ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
+      # @param [string] certificate_id ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
+      # @param [string] certificate_management_policy configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with ``certificate_id``.
+      # @return [NgrokAPI::Models::ReservedDomain] result from update request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-update
+      def update!(
+        id: nil,
+        certificate_id: nil,
+        certificate_management_policy: nil,
+        description: nil,
+        http_endpoint_configuration_id: nil,
+        https_endpoint_configuration_id: nil,
+        metadata: nil
+      )
+        data = build_data(
+          description: description,
+          metadata: metadata,
+          http_endpoint_configuration_id: http_endpoint_configuration_id,
+          https_endpoint_configuration_id: https_endpoint_configuration_id,
+          certificate_id: certificate_id,
+          certificate_management_policy: certificate_management_policy
+        )
+        result = @client.patch("#{PATH}/#{id}", danger: true, data: data)
+        NgrokAPI::Models::ReservedDomain.new(client: self, result: result)
+      end
+      # rubocop:enable LineLength
+
+      ##
+      # Detach the certificate attached from a reserved domain.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate
+      def delete_certificate(id: nil)
+        @client.delete("#{PATH}/#{id}/certificate")
+      end
+
+      ##
+      # Detach the certificate attached from a reserved domain. Throw an exception if 404.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate
+      def delete_certificate!(id: nil)
+        @client.delete("#{PATH}/#{id}/certificate", danger: true)
+      end
+
+      ##
+      # Detach the certificate management policy attached from a reserved domain.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy
+      def delete_certificate_management_policy(id: nil)
+        @client.delete("#{PATH}/#{id}/certificate_management_policy")
+      end
+
+      ##
+      # Detach the certificate management policy attached from a reserved domain.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy
+      def delete_certificate_management_policy!(id: nil)
+        @client.delete("#{PATH}/#{id}/certificate_management_policy", danger: true)
+      end
+
+      ##
+      # Detach the http endpoint configuration attached from a reserved domain.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config
+      def delete_http_endpoint_config(id: nil)
+        @client.delete("#{PATH}/#{id}/http_endpoint_configuration")
+      end
+
+      ##
+      # Detach the http endpoint configuration attached from a reserved domain. Throw an exception if 404.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config
+      def delete_http_endpoint_config!(id: nil)
+        @client.delete("#{PATH}/#{id}/http_endpoint_configuration", danger: true)
+      end
+
+      ##
+      # Detach the https endpoint configuration attached from a reserved domain.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config
+      def delete_https_endpoint_config(id: nil)
+        @client.delete("#{PATH}/#{id}/https_endpoint_configuration")
+      end
+
+      ##
+      # Detach the https endpoint configuration attached from a reserved domain. Throw an exception if 404.
+      #
+      # @param [string] id a resource identifier
+      # @return [nil] result from delete request
+      #
+      # https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config
+      def delete_https_endpoint_config!(id: nil)
+        @client.delete("#{PATH}/#{id}/https_endpoint_configuration", danger: true)
+      end
+
+      private
+
+      def build_data(
+        description: nil,
+        metadata: nil,
+        http_endpoint_configuration_id: nil,
+        https_endpoint_configuration_id: nil,
+        certificate_id: nil,
+        certificate_management_policy: nily
+      )
+        data = {}
+        data[:certificate_id] = certificate_id if certificate_id
+        if certificate_management_policy
+          data[:certificate_management_policy] = certificate_management_policy
+        end
+        data[:description] = description if description
+        if http_endpoint_configuration_id
+          data[:http_endpoint_configuration_id] = http_endpoint_configuration_id
+        end
+        if https_endpoint_configuration_id
+          data[:https_endpoint_configuration_id] = https_endpoint_configuration_id
+        end
+        data[:metadata] = metadata if metadata
+        data
+      end
+    end
+  end
+end