ngrok-api 0.9.0 → 0.12.0

data/lib/ngrokapi/services/ip_restrictions_client.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+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
+    #  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
+    #  public-facing endpoints.
+    #
+    # https://ngrok.com/docs/api#api-ip-restrictions
+    class IPRestrictionsClient
+      # The API path for the requests
+      PATH = '/ip_restrictions'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'ip_restrictions'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new IP restriction
+      #
+      # @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)
+        NgrokAPI::Models::IPRestriction.new(client: self, result: result)
+      end
+
+      ##
+      # Delete an IP restriction
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-restrictions-delete
+      def delete(
+        id: ""
+      )
+        path = '/ip_restrictions/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an IP restriction
+      # 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-ip-restrictions-delete
+      def delete!(
+        id: ""
+      )
+        path = '/ip_restrictions/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about an IP restriction
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::IPRestriction] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-restrictions-get
+      def get(
+        id: ""
+      )
+        path = '/ip_restrictions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::IPRestriction.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about an IP restriction
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::IPRestriction] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-restrictions-get
+      def get!(
+        id: ""
+      )
+        path = '/ip_restrictions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::IPRestriction.new(client: self, result: result)
+      end
+
+      ##
+      # List all IP restrictions on 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-ip-restrictions-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::IPRestriction
+        )
+      end
+
+      ##
+      # Update attributes of an IP restriction by ID
+      #
+      # @param [string] id
+      # @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 [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-update
+      def update(
+        id: "",
+        description: nil,
+        metadata: nil,
+        enforced: nil,
+        ip_policy_ids: []
+      )
+        path = '/ip_restrictions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        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)
+      end
+
+      ##
+      # Update attributes of an IP restriction by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @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 [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-update
+      def update!(
+        id: "",
+        description: nil,
+        metadata: nil,
+        enforced: nil,
+        ip_policy_ids: []
+      )
+        path = '/ip_restrictions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        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)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/ip_whitelist_client.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # The IP Whitelist is deprecated and will be removed. Use an IP Restriction
+    #  with an endpoints type instead.
+    #
+    # https://ngrok.com/docs/api#api-ip-whitelist
+    class IPWhitelistClient
+      # The API path for the requests
+      PATH = '/ip_whitelist'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'whitelist'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new IP whitelist entry that will restrict traffic to all tunnel
+      # endpoints on the account.
+      #
+      # @param [string] description human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
+      # @param [string] ip_net an IP address or IP network range in CIDR notation (e.g. 10.1.1.1 or 10.1.0.0/16) of addresses that will be whitelisted to communicate with your tunnel endpoints
+      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-whitelist-create
+      def create(
+        description: "",
+        metadata: "",
+        ip_net: ""
+      )
+        path = '/ip_whitelist'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:ip_net] = ip_net if ip_net
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::IPWhitelistEntry.new(client: self, result: result)
+      end
+
+      ##
+      # Delete an IP whitelist entry.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-whitelist-delete
+      def delete(
+        id: ""
+      )
+        path = '/ip_whitelist/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an IP whitelist entry.
+      # 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-ip-whitelist-delete
+      def delete!(
+        id: ""
+      )
+        path = '/ip_whitelist/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about an IP whitelist entry by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-whitelist-get
+      def get(
+        id: ""
+      )
+        path = '/ip_whitelist/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::IPWhitelistEntry.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about an IP whitelist entry by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-whitelist-get
+      def get!(
+        id: ""
+      )
+        path = '/ip_whitelist/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::IPWhitelistEntry.new(client: self, result: result)
+      end
+
+      ##
+      # List all IP whitelist entries on 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-ip-whitelist-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::IPWhitelistEntry
+        )
+      end
+
+      ##
+      # Update attributes of an IP whitelist entry by ID
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-whitelist-update
+      def update(
+        id: "",
+        description: nil,
+        metadata: nil
+      )
+        path = '/ip_whitelist/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::IPWhitelistEntry.new(client: self, result: result)
+      end
+
+      ##
+      # Update attributes of an IP whitelist entry by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @param [string] description human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::IPWhitelistEntry] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-whitelist-update
+      def update!(
+        id: "",
+        description: nil,
+        metadata: nil
+      )
+        path = '/ip_whitelist/%{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::IPWhitelistEntry.new(client: self, result: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/reserved_addrs_client.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # Reserved Addresses are TCP addresses that can be used to listen for traffic.
+    #  TCP address hostnames and ports are assigned by ngrok, they cannot be
+    #  chosen.
+    #
+    # https://ngrok.com/docs/api#api-reserved-addrs
+    class ReservedAddrsClient
+      # The API path for the requests
+      PATH = '/reserved_addrs'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'reserved_addrs'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new reserved address.
+      #
+      # @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: ""
+      )
+        path = '/reserved_addrs'
+        replacements = {
+        }
+        data = {}
+        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
+
+      ##
+      # Delete 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
+      def delete(
+        id: ""
+      )
+        path = '/reserved_addrs/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete 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
+      def delete!(
+        id: ""
+      )
+        path = '/reserved_addrs/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get the details of a reserved address.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::ReservedAddr] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-reserved-addrs-get
+      def get(
+        id: ""
+      )
+        path = '/reserved_addrs/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::ReservedAddr.new(client: self, result: result)
+      end
+
+      ##
+      # Get the details of a reserved address.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::ReservedAddr] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-reserved-addrs-get
+      def get!(
+        id: ""
+      )
+        path = '/reserved_addrs/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::ReservedAddr.new(client: self, result: result)
+      end
+
+      ##
+      # List all reserved addresses on 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-reserved-addrs-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::ReservedAddr
+        )
+      end
+
+      ##
+      # Update the attributes of a reserved address.
+      #
+      # @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
+      )
+        path = '/reserved_addrs/%{id}'
+        replacements = {
+          id: id,
+        }
+        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
+
+      ##
+      # Update the attributes of a reserved address.
+      # Throws an exception if API error.
+      #
+      # @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
+      )
+        path = '/reserved_addrs/%{id}'
+        replacements = {
+          id: id,
+        }
+        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