ngrok-api 0.14.0 → 0.17.0

data/lib/ngrokapi/models/{endpoint_configuration.rb → https_edge_route.rb}

@@ -2,53 +2,51 @@
 
 module NgrokAPI
   module Models
-    class EndpointConfiguration
+    class HTTPSEdgeRoute
       attr_reader :client,
         :result,
+        :edge_id,
         :id,
-        :type,
-        :description,
-        :metadata,
         :created_at,
+        :match_type,
+        :match,
         :uri,
-        :basic_auth,
+        :description,
+        :metadata,
+        :backend,
+        :ip_restriction,
         :circuit_breaker,
         :compression,
         :request_headers,
         :response_headers,
-        :ip_policy,
-        :mutual_tls,
-        :tls_termination,
-        :webhook_validation,
+        :webhook_verification,
         :oauth,
-        :logging,
         :saml,
         :oidc,
-        :backend
+        :websocket_tcp_converter
 
       def initialize(client:, result:)
         @client = client
         @result = result
+        @edge_id = @result['edge_id']
         @id = @result['id']
-        @type = @result['type']
-        @description = @result['description']
-        @metadata = @result['metadata']
         @created_at = @result['created_at']
+        @match_type = @result['match_type']
+        @match = @result['match']
         @uri = @result['uri']
-        @basic_auth = @result['basic_auth']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @backend = @result['backend']
+        @ip_restriction = @result['ip_restriction']
         @circuit_breaker = @result['circuit_breaker']
         @compression = @result['compression']
         @request_headers = @result['request_headers']
         @response_headers = @result['response_headers']
-        @ip_policy = @result['ip_policy']
-        @mutual_tls = @result['mutual_tls']
-        @tls_termination = @result['tls_termination']
-        @webhook_validation = @result['webhook_validation']
+        @webhook_verification = @result['webhook_verification']
         @oauth = @result['oauth']
-        @logging = @result['logging']
         @saml = @result['saml']
         @oidc = @result['oidc']
-        @backend = @result['backend']
+        @websocket_tcp_converter = @result['websocket_tcp_converter']
       end
 
       def ==(other)
@@ -60,69 +58,74 @@ module NgrokAPI
       end
 
       ##
-      # Delete an endpoint configuration. This operation will fail if the endpoint
-      # configuration is still referenced by any reserved domain or reserved address.
-      #
-      # https://ngrok.com/docs/api#api-endpoint-configurations-delete
-      def delete
-        @client.delete(
-          id: @id
-        )
-      end
-
-      ##
-      # Updates an endpoint configuration. If a module is not specified in the update,
+      # Updates an HTTPS Edge Route by ID. 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.
       #
-      # https://ngrok.com/docs/api#api-endpoint-configurations-update
+      # https://ngrok.com/docs/api#api-edges-https-routes-update
       def update(
-        description: nil,
-        metadata: nil,
+        match_type: "",
+        match: "",
+        description: "",
+        metadata: "",
+        backend: nil,
+        ip_restriction: nil,
         circuit_breaker: nil,
         compression: nil,
         request_headers: nil,
         response_headers: nil,
-        ip_policy: nil,
-        mutual_tls: nil,
-        tls_termination: nil,
-        webhook_validation: nil,
+        webhook_verification: nil,
         oauth: nil,
-        logging: nil,
         saml: nil,
-        oidc: nil
+        oidc: nil,
+        websocket_tcp_converter: nil
       )
+        @match_type = match_type if match_type
+        @match = match if match
         @description = description if description
         @metadata = metadata if metadata
+        @backend = backend if backend
+        @ip_restriction = ip_restriction if ip_restriction
         @circuit_breaker = circuit_breaker if circuit_breaker
         @compression = compression if compression
         @request_headers = request_headers if request_headers
         @response_headers = response_headers if response_headers
-        @ip_policy = ip_policy if ip_policy
-        @mutual_tls = mutual_tls if mutual_tls
-        @tls_termination = tls_termination if tls_termination
-        @webhook_validation = webhook_validation if webhook_validation
+        @webhook_verification = webhook_verification if webhook_verification
         @oauth = oauth if oauth
-        @logging = logging if logging
         @saml = saml if saml
         @oidc = oidc if oidc
+        @websocket_tcp_converter = websocket_tcp_converter if websocket_tcp_converter
         @client.update(
+          edge_id: @edge_id,
           id: @id,
+          match_type: match_type,
+          match: match,
           description: description,
           metadata: metadata,
+          backend: backend,
+          ip_restriction: ip_restriction,
           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,
+          webhook_verification: webhook_verification,
           oauth: oauth,
-          logging: logging,
           saml: saml,
-          oidc: oidc
+          oidc: oidc,
+          websocket_tcp_converter: websocket_tcp_converter
+        )
+      end
+
+      ##
+      # Delete an HTTPS Edge Route by ID
+      #
+      # https://ngrok.com/docs/api#api-edges-https-routes-delete
+      def delete(
+      )
+        @client.delete(
+          edge_id: @edge_id,
+          id: @id
         )
       end
     end

data/lib/ngrokapi/models/ip_policy_rule.rb

@@ -11,7 +11,8 @@ module NgrokAPI
         :description,
         :metadata,
         :cidr,
-        :ip_policy
+        :ip_policy,
+        :action
 
       def initialize(client:, result:)
         @client = client
@@ -23,6 +24,7 @@ module NgrokAPI
         @metadata = @result['metadata']
         @cidr = @result['cidr']
         @ip_policy = @result['ip_policy']
+        @action = @result['action']
       end
 
       def ==(other)

data/lib/ngrokapi/models/tcp_edge.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TCPEdge
+      attr_reader :client,
+        :result,
+        :id,
+        :description,
+        :metadata,
+        :created_at,
+        :uri,
+        :hostports,
+        :backend,
+        :ip_restriction
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @created_at = @result['created_at']
+        @uri = @result['uri']
+        @hostports = @result['hostports']
+        @backend = @result['backend']
+        @ip_restriction = @result['ip_restriction']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Updates a TCP Edge by ID. 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.
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-update
+      def update(
+        description: nil,
+        metadata: nil,
+        hostports: nil,
+        backend: nil,
+        ip_restriction: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @hostports = hostports if hostports
+        @backend = backend if backend
+        @ip_restriction = ip_restriction if ip_restriction
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          hostports: hostports,
+          backend: backend,
+          ip_restriction: ip_restriction
+        )
+      end
+
+      ##
+      # Delete a TCP Edge by ID
+      #
+      # https://ngrok.com/docs/api#api-edges-tcp-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tls_edge.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TLSEdge
+      attr_reader :client,
+        :result,
+        :id,
+        :description,
+        :metadata,
+        :created_at,
+        :uri,
+        :hostports,
+        :backend,
+        :ip_restriction,
+        :mutual_tls,
+        :tls_termination
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @created_at = @result['created_at']
+        @uri = @result['uri']
+        @hostports = @result['hostports']
+        @backend = @result['backend']
+        @ip_restriction = @result['ip_restriction']
+        @mutual_tls = @result['mutual_tls']
+        @tls_termination = @result['tls_termination']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Updates a TLS Edge by ID. 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.
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-update
+      def update(
+        description: nil,
+        metadata: nil,
+        hostports: nil,
+        backend: nil,
+        ip_restriction: nil,
+        mutual_tls: nil,
+        tls_termination: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @hostports = hostports if hostports
+        @backend = backend if backend
+        @ip_restriction = ip_restriction if ip_restriction
+        @mutual_tls = mutual_tls if mutual_tls
+        @tls_termination = tls_termination if tls_termination
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          hostports: hostports,
+          backend: backend,
+          ip_restriction: ip_restriction,
+          mutual_tls: mutual_tls,
+          tls_termination: tls_termination
+        )
+      end
+
+      ##
+      # Delete a TLS Edge by ID
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tunnel.rb

@@ -11,7 +11,11 @@ module NgrokAPI
         :metadata,
         :proto,
         :region,
-        :tunnel_session
+        :tunnel_session,
+        :endpoint,
+        :labels,
+        :backends,
+        :forwards_to
 
       def initialize(client:, result:)
         @client = client
@@ -23,6 +27,10 @@ module NgrokAPI
         @proto = @result['proto']
         @region = @result['region']
         @tunnel_session = @result['tunnel_session']
+        @endpoint = @result['endpoint']
+        @labels = @result['labels']
+        @backends = @result['backends']
+        @forwards_to = @result['forwards_to']
       end
 
       def ==(other)

data/lib/ngrokapi/models/tunnel_group_backend.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class TunnelGroupBackend
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :labels,
+        :tunnels
+
+      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']
+        @labels = @result['labels']
+        @tunnels = @result['tunnels']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete a TunnelGroup backend by ID. TODO what if used?
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update TunnelGroup backend by ID
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-update
+      def update(
+        description: nil,
+        metadata: nil,
+        labels: {}
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @labels = labels if labels
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          labels: labels
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/weighted_backend.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class WeightedBackend
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :backends
+
+      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']
+        @backends = @result['backends']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete a Weighted backend by ID. TODO what if used?
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update Weighted backend by ID
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-update
+      def update(
+        description: nil,
+        metadata: nil,
+        backends: {}
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @backends = backends if backends
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          backends: backends
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/abuse_reports_client.rb

@@ -27,10 +27,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::AbuseReport] result from the API request
       #
       # https://ngrok.com/docs/api#api-abuse-reports-create
-      def create(
-        urls:,
-        metadata: ""
-      )
+      def create(urls:, metadata: "")
         path = '/abuse_reports'
         replacements = {
         }
@@ -48,9 +45,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::AbuseReport] result from the API request
       #
       # https://ngrok.com/docs/api#api-abuse-reports-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/abuse_reports/%{id}'
         replacements = {
           id: id,
@@ -68,9 +63,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::AbuseReport] result from the API request
       #
       # https://ngrok.com/docs/api#api-abuse-reports-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/abuse_reports/%{id}'
         replacements = {
           id: id,