ngrok-api 0.14.0 → 0.17.0

data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb

@@ -0,0 +1,108 @@
+# 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 = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data)
+        NgrokAPI::Models::EndpointTLSTermination.new(client: self, result: 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 = {}
+        data[:module] = a_module if a_module
+        result = @client.put(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EndpointTLSTermination.new(client: self, result: 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, result: 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, result: 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,22 +27,16 @@ 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)
       end
@@ -56,9 +50,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policies-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/ip_policies/%{id}'
         replacements = {
           id: id,
@@ -76,9 +68,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policies-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/ip_policies/%{id}'
         replacements = {
           id: id,
@@ -93,9 +83,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPPolicy] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policies-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/ip_policies/%{id}'
         replacements = {
           id: id,
@@ -113,9 +101,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPPolicy] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policies-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/ip_policies/%{id}'
         replacements = {
           id: id,
@@ -134,11 +120,8 @@ 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,
@@ -164,11 +147,8 @@ 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,
@@ -195,11 +175,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPPolicy] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policies-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update(id: "", description: nil, metadata: nil)
         path = '/ip_policies/%{id}'
         replacements = {
           id: id,
@@ -221,11 +197,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPPolicy] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policies-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil
-      )
+      def update!(id: "", description: nil, metadata: nil)
         path = '/ip_policies/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/ip_policy_rules_client.rb

@@ -26,15 +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 = {
         }
@@ -43,6 +39,7 @@ 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)
       end
@@ -54,9 +51,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/ip_policy_rules/%{id}'
         replacements = {
           id: id,
@@ -72,9 +67,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/ip_policy_rules/%{id}'
         replacements = {
           id: id,
@@ -89,9 +82,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPPolicyRule] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/ip_policy_rules/%{id}'
         replacements = {
           id: id,
@@ -109,9 +100,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPPolicyRule] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/ip_policy_rules/%{id}'
         replacements = {
           id: id,
@@ -130,11 +119,8 @@ 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,
@@ -160,11 +146,8 @@ 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,
@@ -192,12 +175,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPPolicyRule] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil,
-        cidr: nil
-      )
+      def update(id: "", description: nil, metadata: nil, cidr: nil)
         path = '/ip_policy_rules/%{id}'
         replacements = {
           id: id,
@@ -221,12 +199,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPPolicyRule] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil,
-        cidr: nil
-      )
+      def update!(id: "", description: nil, metadata: nil, cidr: nil)
         path = '/ip_policy_rules/%{id}'
         replacements = {
           id: id,

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
@@ -34,13 +34,7 @@ module NgrokAPI
       # @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:
-      )
+      def create(description: "", metadata: "", enforced: False, type:, ip_policy_ids:)
         path = '/ip_restrictions'
         replacements = {
         }
@@ -61,9 +55,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/ip_restrictions/%{id}'
         replacements = {
           id: id,
@@ -79,9 +71,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/ip_restrictions/%{id}'
         replacements = {
           id: id,
@@ -96,9 +86,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPRestriction] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/ip_restrictions/%{id}'
         replacements = {
           id: id,
@@ -116,9 +104,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPRestriction] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/ip_restrictions/%{id}'
         replacements = {
           id: id,
@@ -137,11 +123,8 @@ 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,
@@ -167,11 +150,8 @@ 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,
@@ -200,13 +180,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPRestriction] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil,
-        enforced: nil,
-        ip_policy_ids: []
-      )
+      def update(id: "", description: nil, metadata: nil, enforced: nil, ip_policy_ids: [])
         path = '/ip_restrictions/%{id}'
         replacements = {
           id: id,
@@ -232,13 +206,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::IPRestriction] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil,
-        enforced: nil,
-        ip_policy_ids: []
-      )
+      def update!(id: "", description: nil, metadata: nil, enforced: nil, ip_policy_ids: [])
         path = '/ip_restrictions/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/reserved_addrs_client.rb

@@ -26,16 +26,10 @@ module NgrokAPI
       # @param [string] description human-readable description of what this reserved address will be used for
       # @param [string] metadata arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
       # @param [string] region reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
-      # @param [string] endpoint_configuration_id ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
       # @return [NgrokAPI::Models::ReservedAddr] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-create
-      def create(
-        description: "",
-        metadata: "",
-        region: "",
-        endpoint_configuration_id: ""
-      )
+      def create(description: "", metadata: "", region: "", endpoint_configuration_id: nil)
         path = '/reserved_addrs'
         replacements = {
         }
@@ -43,7 +37,6 @@ module NgrokAPI
         data[:description] = description if description
         data[:metadata] = metadata if metadata
         data[:region] = region if region
-        data[:endpoint_configuration_id] = endpoint_configuration_id if endpoint_configuration_id
         result = @client.post(path % replacements, data: data)
         NgrokAPI::Models::ReservedAddr.new(client: self, result: result)
       end
@@ -55,9 +48,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-delete
-      def delete(
-        id: ""
-      )
+      def delete(id: "")
         path = '/reserved_addrs/%{id}'
         replacements = {
           id: id,
@@ -73,9 +64,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Empty] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-delete
-      def delete!(
-        id: ""
-      )
+      def delete!(id: "")
         path = '/reserved_addrs/%{id}'
         replacements = {
           id: id,
@@ -90,9 +79,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::ReservedAddr] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-get
-      def get(
-        id: ""
-      )
+      def get(id: "")
         path = '/reserved_addrs/%{id}'
         replacements = {
           id: id,
@@ -110,9 +97,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::ReservedAddr] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-get
-      def get!(
-        id: ""
-      )
+      def get!(id: "")
         path = '/reserved_addrs/%{id}'
         replacements = {
           id: id,
@@ -131,11 +116,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-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,11 +143,8 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-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,
@@ -189,16 +168,10 @@ module NgrokAPI
       # @param [string] id
       # @param [string] description human-readable description of what this reserved address will be used for
       # @param [string] metadata arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
-      # @param [string] endpoint_configuration_id ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
       # @return [NgrokAPI::Models::ReservedAddr] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-update
-      def update(
-        id: "",
-        description: nil,
-        metadata: nil,
-        endpoint_configuration_id: nil
-      )
+      def update(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil)
         path = '/reserved_addrs/%{id}'
         replacements = {
           id: id,
@@ -206,7 +179,6 @@ module NgrokAPI
         data = {}
         data[:description] = description if description
         data[:metadata] = metadata if metadata
-        data[:endpoint_configuration_id] = endpoint_configuration_id if endpoint_configuration_id
         result = @client.patch(path % replacements, data: data)
         NgrokAPI::Models::ReservedAddr.new(client: self, result: result)
       end
@@ -218,16 +190,10 @@ module NgrokAPI
       # @param [string] id
       # @param [string] description human-readable description of what this reserved address will be used for
       # @param [string] metadata arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
-      # @param [string] endpoint_configuration_id ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
       # @return [NgrokAPI::Models::ReservedAddr] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-update
-      def update!(
-        id: "",
-        description: nil,
-        metadata: nil,
-        endpoint_configuration_id: nil
-      )
+      def update!(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil)
         path = '/reserved_addrs/%{id}'
         replacements = {
           id: id,
@@ -235,45 +201,9 @@ module NgrokAPI
         data = {}
         data[:description] = description if description
         data[:metadata] = metadata if metadata
-        data[:endpoint_configuration_id] = endpoint_configuration_id if endpoint_configuration_id
         result = @client.patch(path % replacements, data: data, danger: true)
         NgrokAPI::Models::ReservedAddr.new(client: self, result: result)
       end
-
-      ##
-      # Detach the endpoint configuration attached to a reserved address.
-      #
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::Empty] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-reserved-addrs-delete-endpoint-config
-      def delete_endpoint_config(
-        id: ""
-      )
-        path = '/reserved_addrs/%{id}/endpoint_configuration'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements)
-      end
-
-      ##
-      # Detach the endpoint configuration attached to a reserved address.
-      # 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-reserved-addrs-delete-endpoint-config
-      def delete_endpoint_config!(
-        id: ""
-      )
-        path = '/reserved_addrs/%{id}/endpoint_configuration'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements, danger: true)
-      end
     end
   end
 end