ngrok-api 0.9.0 → 0.12.0

data/lib/ngrokapi/services/event_subscriptions_client.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-event-subscriptions
+    class EventSubscriptionsClient
+      # The API path for the requests
+      PATH = '/event_subscriptions'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'event_subscriptions'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create an Event Subscription.
+      #
+      # @param [string] metadata Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
+      # @param [string] description Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
+      # @param [List<EventSourceReplace>] sources Sources containing the types for which this event subscription will trigger
+      # @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
+      # @return [NgrokAPI::Models::EventSubscription] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-event-subscriptions-create
+      def create(
+        metadata: "",
+        description: "",
+        sources: [],
+        destination_ids: []
+      )
+        path = '/event_subscriptions'
+        replacements = {
+        }
+        data = {}
+        data[:metadata] = metadata if metadata
+        data[:description] = description if description
+        data[:sources] = sources if sources
+        data[:destination_ids] = destination_ids if destination_ids
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::EventSubscription.new(client: self, result: result)
+      end
+
+      ##
+      # Delete an Event Subscription.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-event-subscriptions-delete
+      def delete(
+        id: ""
+      )
+        path = '/event_subscriptions/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an Event Subscription.
+      # 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-event-subscriptions-delete
+      def delete!(
+        id: ""
+      )
+        path = '/event_subscriptions/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get an Event Subscription by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EventSubscription] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-event-subscriptions-get
+      def get(
+        id: ""
+      )
+        path = '/event_subscriptions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::EventSubscription.new(client: self, result: result)
+      end
+
+      ##
+      # Get an Event Subscription by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::EventSubscription] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-event-subscriptions-get
+      def get!(
+        id: ""
+      )
+        path = '/event_subscriptions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EventSubscription.new(client: self, result: result)
+      end
+
+      ##
+      # List this Account's Event Subscriptions.
+      #
+      # @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-event-subscriptions-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::EventSubscription
+        )
+      end
+
+      ##
+      # Update an Event Subscription.
+      #
+      # @param [string] id Unique identifier for this Event Subscription.
+      # @param [string] metadata Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
+      # @param [string] description Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
+      # @param [List<EventSourceReplace>] sources Sources containing the types for which this event subscription will trigger
+      # @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
+      # @return [NgrokAPI::Models::EventSubscription] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-event-subscriptions-update
+      def update(
+        id: "",
+        metadata: nil,
+        description: nil,
+        sources: nil,
+        destination_ids: nil
+      )
+        path = '/event_subscriptions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:metadata] = metadata if metadata
+        data[:description] = description if description
+        data[:sources] = sources if sources
+        data[:destination_ids] = destination_ids if destination_ids
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::EventSubscription.new(client: self, result: result)
+      end
+
+      ##
+      # Update an Event Subscription.
+      # Throws an exception if API error.
+      #
+      # @param [string] id Unique identifier for this Event Subscription.
+      # @param [string] metadata Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
+      # @param [string] description Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
+      # @param [List<EventSourceReplace>] sources Sources containing the types for which this event subscription will trigger
+      # @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
+      # @return [NgrokAPI::Models::EventSubscription] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-event-subscriptions-update
+      def update!(
+        id: "",
+        metadata: nil,
+        description: nil,
+        sources: nil,
+        destination_ids: nil
+      )
+        path = '/event_subscriptions/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:metadata] = metadata if metadata
+        data[:description] = description if description
+        data[:sources] = sources if sources
+        data[:destination_ids] = destination_ids if destination_ids
+        result = @client.patch(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EventSubscription.new(client: self, result: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/ip_policies_client.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # IP Policies are reusable groups of CIDR ranges with an allow or deny
+    #  action. They can be attached to endpoints via the Endpoint Configuration IP
+    #  Policy module. They can also be used with IP Restrictions to control source
+    #  IP ranges that can start tunnel sessions and connect to the API and dashboard.
+    #
+    # https://ngrok.com/docs/api#api-ip-policies
+    class IPPoliciesClient
+      # The API path for the requests
+      PATH = '/ip_policies'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'ip_policies'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      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.
+      #
+      # @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:
+      )
+        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
+
+      ##
+      # Delete an IP policy. If the IP policy is referenced by another object for the
+      # purposes of traffic restriction it will be treated as if the IP policy remains
+      # but has zero rules.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-policies-delete
+      def delete(
+        id: ""
+      )
+        path = '/ip_policies/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an IP policy. If the IP policy is referenced by another object for the
+      # purposes of traffic restriction it will be treated as if the IP policy remains
+      # but has zero rules.
+      # 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-policies-delete
+      def delete!(
+        id: ""
+      )
+        path = '/ip_policies/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about an IP policy by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::IPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-policies-get
+      def get(
+        id: ""
+      )
+        path = '/ip_policies/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::IPPolicy.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about an IP policy by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::IPPolicy] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-policies-get
+      def get!(
+        id: ""
+      )
+        path = '/ip_policies/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::IPPolicy.new(client: self, result: result)
+      end
+
+      ##
+      # List all IP policies 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-policies-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::IPPolicy
+        )
+      end
+
+      ##
+      # Update attributes of an IP policy by ID
+      #
+      # @param [string] id
+      # @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-update
+      def update(
+        id: "",
+        description: nil,
+        metadata: nil
+      )
+        path = '/ip_policies/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        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)
+      end
+
+      ##
+      # Update attributes of an IP policy by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @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-update
+      def update!(
+        id: "",
+        description: nil,
+        metadata: nil
+      )
+        path = '/ip_policies/%{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::IPPolicy.new(client: self, result: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/ip_policy_rules_client.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
+    #  make up an IP Policy.
+    #
+    # https://ngrok.com/docs/api#api-ip-policy-rules
+    class IPPolicyRulesClient
+      # The API path for the requests
+      PATH = '/ip_policy_rules'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'ip_policy_rules'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new IP policy rule attached to an IP Policy.
+      #
+      # @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
+      # @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:
+      )
+        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
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::IPPolicyRule.new(client: self, result: result)
+      end
+
+      ##
+      # Delete an IP policy rule.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-policy-rules-delete
+      def delete(
+        id: ""
+      )
+        path = '/ip_policy_rules/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete an IP policy rule.
+      # 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-policy-rules-delete
+      def delete!(
+        id: ""
+      )
+        path = '/ip_policy_rules/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about an IP policy rule by ID.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::IPPolicyRule] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-policy-rules-get
+      def get(
+        id: ""
+      )
+        path = '/ip_policy_rules/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::IPPolicyRule.new(client: self, result: result)
+      end
+
+      ##
+      # Get detailed information about an IP policy rule by ID.
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::IPPolicyRule] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-ip-policy-rules-get
+      def get!(
+        id: ""
+      )
+        path = '/ip_policy_rules/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::IPPolicyRule.new(client: self, result: result)
+      end
+
+      ##
+      # List all IP policy rules 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-policy-rules-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::IPPolicyRule
+        )
+      end
+
+      ##
+      # Update attributes of an IP policy rule by ID
+      #
+      # @param [string] id
+      # @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.
+      # @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
+      )
+        path = '/ip_policy_rules/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        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)
+      end
+
+      ##
+      # Update attributes of an IP policy rule by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @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.
+      # @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
+      )
+        path = '/ip_policy_rules/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        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)
+      end
+    end
+  end
+end