ngrok-api 0.16.0 → 0.19.0

data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → https_edge_mutual_tls_module_client.rb}

@@ -3,10 +3,10 @@
 module NgrokAPI
   module Services
     ##
-    # https://ngrok.com/docs/api#api-endpoint-oidc-module
-    class EndpointOIDCModuleClient
+    # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module
+    class HTTPSEdgeMutualTLSModuleClient
       # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/oidc'
+      PATH = '/edges/https/%{id}/mutual_tls'
 
       attr_reader :client
 
@@ -16,75 +16,73 @@ module NgrokAPI
 
       ##
       # @param [string] id
-      # @param [EndpointOIDC] a_module
-      # @return [NgrokAPI::Models::EndpointOIDC] result from the API request
+      # @param [EndpointMutualTLSMutate] a_module
+      # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-oidc-module-replace
+      # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-replace
       def replace(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/oidc'
+        path = '/edges/https/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
-        data = {}
-        data[:module] = a_module if a_module
+        data = a_module
         result = @client.put(path % replacements, data: data)
-        NgrokAPI::Models::EndpointOIDC.new(client: self, result: result)
+        NgrokAPI::Models::EndpointMutualTLS.new(client: self, attrs: result)
       end
 
       ##
       # @param [string] id
-      # @param [EndpointOIDC] a_module
-      # @return [NgrokAPI::Models::EndpointOIDC] result from the API request
+      # @param [EndpointMutualTLSMutate] a_module
+      # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-oidc-module-replace
+      # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-replace
       def replace!(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/oidc'
+        path = '/edges/https/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
-        data = {}
-        data[:module] = a_module if a_module
+        data = a_module
         result = @client.put(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointOIDC.new(client: self, result: result)
+        NgrokAPI::Models::EndpointMutualTLS.new(client: self, attrs: result)
       end
 
       ##
       # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointOIDC] result from the API request
+      # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-oidc-module-get
+      # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-get
       def get(id: "")
-        path = '/endpoint_configurations/%{id}/oidc'
+        path = '/edges/https/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EndpointOIDC.new(client: self, result: result)
+        NgrokAPI::Models::EndpointMutualTLS.new(client: self, attrs: result)
       end
 
       ##
       # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointOIDC] result from the API request
+      # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-oidc-module-get
+      # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-get
       def get!(id: "")
-        path = '/endpoint_configurations/%{id}/oidc'
+        path = '/edges/https/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointOIDC.new(client: self, result: result)
+        NgrokAPI::Models::EndpointMutualTLS.new(client: self, attrs: result)
       end
 
       ##
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-oidc-module-delete
+      # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-delete
       def delete(id: "")
-        path = '/endpoint_configurations/%{id}/oidc'
+        path = '/edges/https/%{id}/mutual_tls'
         replacements = {
           id: id,
         }
@@ -95,9 +93,9 @@ module NgrokAPI
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
-      # https://ngrok.com/docs/api#api-endpoint-oidc-module-delete
+      # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-delete
       def delete!(id: "")
-        path = '/endpoint_configurations/%{id}/oidc'
+        path = '/edges/https/%{id}/mutual_tls'
         replacements = {
           id: id,
         }

data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-https-edge-tls-termination-module
+    class HTTPSEdgeTLSTerminationModuleClient
+      # The API path for the requests
+      PATH = '/edges/https/%{id}/tls_termination'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] id
+      # @param [EndpointTLSTerminationAtEdge] a_module
+      # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-replace
+      def replace(id: "", a_module: nil)
+        path = '/edges/https/%{id}/tls_termination'
+        replacements = {
+          id: id,
+        }
+        data = a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointTLSTermination.new(client: self, attrs: result)
+      end
+
+      ##
+      # @param [string] id
+      # @param [EndpointTLSTerminationAtEdge] a_module
+      # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-replace
+      def replace!(id: "", a_module: nil)
+        path = '/edges/https/%{id}/tls_termination'
+        replacements = {
+          id: id,
+        }
+        data = a_module
+        result = @client.put(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointTLSTermination.new(client: self, attrs: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-get
+      def get(id: "")
+        path = '/edges/https/%{id}/tls_termination'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EndpointTLSTermination.new(client: self, attrs: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-get
+      def get!(id: "")
+        path = '/edges/https/%{id}/tls_termination'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointTLSTermination.new(client: self, attrs: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-delete
+      def delete(id: "")
+        path = '/edges/https/%{id}/tls_termination'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-delete
+      def delete!(id: "")
+        path = '/edges/https/%{id}/tls_termination'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/ip_policies_client.rb

@@ -27,20 +27,39 @@ module NgrokAPI
       #
       # @param [string] description human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
       # @param [string] metadata arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
-      # @param [string] action the IP policy action. Supported values are ``allow`` or ``deny``
       # @return [NgrokAPI::Models::IPPolicy] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policies-create
-      def create(description: "", metadata: "", action:)
+      def create(description: "", metadata: "", action: nil)
         path = '/ip_policies'
         replacements = {
         }
         data = {}
         data[:description] = description if description
         data[:metadata] = metadata if metadata
-        data[:action] = action if action
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::IPPolicy.new(client: self, result: result)
+        NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new IP policy. It will not apply to any traffic until you associate to
+      # a traffic source via an endpoint configuration or IP restriction.
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::IPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-policies-create
+      def create!(description: "", metadata: "", action: nil)
+        path = '/ip_policies'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
       end
 
       ##
@@ -92,7 +111,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::IPPolicy.new(client: self, result: result)
+        NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
       end
 
       ##
@@ -110,7 +129,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::IPPolicy.new(client: self, result: result)
+        NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
       end
 
       ##
@@ -122,8 +141,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policies-list
-      def list(before_id: nil, limit: nil,
-               url: nil)
+      def list(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -133,7 +151,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::IPPolicy
         )
@@ -149,8 +167,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policies-list
-      def list!(before_id: nil, limit: nil,
-                url: nil)
+      def list!(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -161,7 +178,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::IPPolicy,
           danger: true
@@ -186,7 +203,7 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::IPPolicy.new(client: self, result: result)
+        NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
       end
 
       ##
@@ -208,7 +225,7 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::IPPolicy.new(client: self, result: result)
+        NgrokAPI::Models::IPPolicy.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/services/ip_policy_rules_client.rb

@@ -26,10 +26,11 @@ module NgrokAPI
       # @param [string] metadata arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
       # @param [string] cidr an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
       # @param [string] ip_policy_id ID of the IP policy this IP policy rule will be attached to
+      # @param [string] action the action to apply to the policy rule, either ``allow`` or ``deny``
       # @return [NgrokAPI::Models::IPPolicyRule] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-create
-      def create(description: "", metadata: "", cidr:, ip_policy_id:)
+      def create(description: "", metadata: "", cidr:, ip_policy_id:, action: nil)
         path = '/ip_policy_rules'
         replacements = {
         }
@@ -38,8 +39,35 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:cidr] = cidr if cidr
         data[:ip_policy_id] = ip_policy_id if ip_policy_id
+        data[:action] = action if action
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::IPPolicyRule.new(client: self, result: result)
+        NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new IP policy rule attached to an IP Policy.
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
+      # @param [string] cidr an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
+      # @param [string] ip_policy_id ID of the IP policy this IP policy rule will be attached to
+      # @param [string] action the action to apply to the policy rule, either ``allow`` or ``deny``
+      # @return [NgrokAPI::Models::IPPolicyRule] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-policy-rules-create
+      def create!(description: "", metadata: "", cidr:, ip_policy_id:, action: nil)
+        path = '/ip_policy_rules'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:cidr] = cidr if cidr
+        data[:ip_policy_id] = ip_policy_id if ip_policy_id
+        data[:action] = action if action
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
       end
 
       ##
@@ -87,7 +115,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::IPPolicyRule.new(client: self, result: result)
+        NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
       end
 
       ##
@@ -105,7 +133,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::IPPolicyRule.new(client: self, result: result)
+        NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
       end
 
       ##
@@ -117,8 +145,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-list
-      def list(before_id: nil, limit: nil,
-               url: nil)
+      def list(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -128,7 +155,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::IPPolicyRule
         )
@@ -144,8 +171,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-list
-      def list!(before_id: nil, limit: nil,
-                url: nil)
+      def list!(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -156,7 +182,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::IPPolicyRule,
           danger: true
@@ -183,7 +209,7 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:cidr] = cidr if cidr
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::IPPolicyRule.new(client: self, result: result)
+        NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
       end
 
       ##
@@ -207,7 +233,7 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:cidr] = cidr if cidr
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::IPPolicyRule.new(client: self, result: result)
+        NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/services/ip_restrictions_client.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Services
     ##
     # An IP restriction is a restriction placed on the CIDRs that are allowed to
-    #  initate traffic to a specific aspect of your ngrok account. An IP
+    #  initiate traffic to a specific aspect of your ngrok account. An IP
     #  restriction has a type which defines the ingress it applies to. IP
     #  restrictions can be used to enforce the source IPs that can make API
     #  requests, log in to the dashboard, start ngrok agents, and connect to your
@@ -45,7 +45,33 @@ module NgrokAPI
         data[:type] = type if type
         data[:ip_policy_ids] = ip_policy_ids if ip_policy_ids
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::IPRestriction.new(client: self, result: result)
+        NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new IP restriction
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of this IP restriction. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
+      # @param [boolean] enforced true if the IP restriction will be enforced. if false, only warnings will be issued
+      # @param [string] type the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: ``dashboard``, ``api``, ``agent``, and ``endpoints``
+      # @param [List<string>] ip_policy_ids the set of IP policy identifiers that are used to enforce the restriction
+      # @return [NgrokAPI::Models::IPRestriction] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-restrictions-create
+      def create!(description: "", metadata: "", enforced: False, type:, ip_policy_ids:)
+        path = '/ip_restrictions'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:enforced] = enforced if enforced
+        data[:type] = type if type
+        data[:ip_policy_ids] = ip_policy_ids if ip_policy_ids
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
       end
 
       ##
@@ -93,7 +119,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::IPRestriction.new(client: self, result: result)
+        NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
       end
 
       ##
@@ -111,7 +137,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::IPRestriction.new(client: self, result: result)
+        NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
       end
 
       ##
@@ -123,8 +149,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-list
-      def list(before_id: nil, limit: nil,
-               url: nil)
+      def list(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -134,7 +159,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::IPRestriction
         )
@@ -150,8 +175,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-list
-      def list!(before_id: nil, limit: nil,
-                url: nil)
+      def list!(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -162,7 +186,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::IPRestriction,
           danger: true
@@ -191,7 +215,7 @@ module NgrokAPI
         data[:enforced] = enforced if enforced
         data[:ip_policy_ids] = ip_policy_ids if ip_policy_ids
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::IPRestriction.new(client: self, result: result)
+        NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
       end
 
       ##
@@ -217,7 +241,7 @@ module NgrokAPI
         data[:enforced] = enforced if enforced
         data[:ip_policy_ids] = ip_policy_ids if ip_policy_ids
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::IPRestriction.new(client: self, result: result)
+        NgrokAPI::Models::IPRestriction.new(client: self, attrs: result)
       end
     end
   end