ngrok-api 0.18.0 → 0.21.0

data/lib/ngrokapi/services/edges_tls_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -42,7 +44,37 @@ module NgrokAPI
         data[:mutual_tls] = mutual_tls if mutual_tls
         data[:tls_termination] = tls_termination if tls_termination
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::TLSEdge.new(client: self, result: result)
+        NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a TLS Edge
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes.
+      # @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
+      # @param [List<string>] hostports hostports served by this edge
+      # @param [EndpointBackendMutate] backend edge modules
+      # @param [EndpointIPPolicyMutate] ip_restriction
+      # @param [EndpointMutualTLSMutate] mutual_tls
+      # @param [EndpointTLSTermination] tls_termination
+      # @return [NgrokAPI::Models::TLSEdge] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-edges-tls-create
+      def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
+        path = '/edges/tls'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:hostports] = hostports if hostports
+        data[:backend] = backend if backend
+        data[:ip_restriction] = ip_restriction if ip_restriction
+        data[:mutual_tls] = mutual_tls if mutual_tls
+        data[:tls_termination] = tls_termination if tls_termination
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
       end
 
       ##
@@ -59,7 +91,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::TLSEdge.new(client: self, result: result)
+        NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
       end
 
       ##
@@ -77,7 +109,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::TLSEdge.new(client: self, result: result)
+        NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
       end
 
       ##
@@ -89,8 +121,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-edges-tls-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,
@@ -100,7 +131,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::TLSEdge
         )
@@ -116,8 +147,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-edges-tls-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 +158,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::TLSEdge,
           danger: true
@@ -166,7 +196,7 @@ module NgrokAPI
         data[:mutual_tls] = mutual_tls if mutual_tls
         data[:tls_termination] = tls_termination if tls_termination
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::TLSEdge.new(client: self, result: result)
+        NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
       end
 
       ##
@@ -201,7 +231,7 @@ module NgrokAPI
         data[:mutual_tls] = mutual_tls if mutual_tls
         data[:tls_termination] = tls_termination if tls_termination
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::TLSEdge.new(client: self, result: result)
+        NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
       end
 
       ##

data/lib/ngrokapi/services/endpoints_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -29,8 +31,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-endpoints-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,
@@ -40,7 +41,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::Endpoint
         )
@@ -56,8 +57,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-endpoints-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,
@@ -68,7 +68,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::Endpoint,
           danger: true
@@ -89,7 +89,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::Endpoint.new(client: self, result: result)
+        NgrokAPI::Models::Endpoint.new(client: self, attrs: result)
       end
 
       ##
@@ -107,7 +107,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::Endpoint.new(client: self, result: result)
+        NgrokAPI::Models::Endpoint.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/services/event_destinations_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -18,8 +20,7 @@ module NgrokAPI
 
       ##
       # Create a new Event Destination. It will not apply to anything until it is
-      # associated with an Event Stream, and that Event Stream is associated with an
-      # Endpoint Config.
+      # associated with an Event Subscription.
       #
       # @param [string] metadata Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
       # @param [string] description Human-readable description of the Event Destination. Optional, max 255 bytes.
@@ -38,7 +39,32 @@ module NgrokAPI
         data[:format] = format if format
         data[:target] = target if target
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::EventDestination.new(client: self, result: result)
+        NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new Event Destination. It will not apply to anything until it is
+      # associated with an Event Subscription.
+      # Throws an exception if API error.
+      #
+      # @param [string] metadata Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
+      # @param [string] description Human-readable description of the Event Destination. Optional, max 255 bytes.
+      # @param [string] format The output format you would like to serialize events into when sending to their target. Currently the only accepted value is ``JSON``.
+      # @param [EventTarget] target An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: ``kinesis``, ``firehose``, ``cloudwatch_logs``, or ``s3``.
+      # @return [NgrokAPI::Models::EventDestination] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-event-destinations-create
+      def create!(metadata: "", description: "", format: "", target: nil, verify_with_test_event: nil)
+        path = '/event_destinations'
+        replacements = {
+        }
+        data = {}
+        data[:metadata] = metadata if metadata
+        data[:description] = description if description
+        data[:format] = format if format
+        data[:target] = target if target
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
       end
 
       ##
@@ -88,7 +114,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EventDestination.new(client: self, result: result)
+        NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
       end
 
       ##
@@ -106,7 +132,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EventDestination.new(client: self, result: result)
+        NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
       end
 
       ##
@@ -118,8 +144,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-destinations-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,
@@ -129,7 +154,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::EventDestination
         )
@@ -145,8 +170,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-event-destinations-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,
@@ -157,7 +181,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::EventDestination,
           danger: true
@@ -186,7 +210,7 @@ module NgrokAPI
         data[:format] = format if format
         data[:target] = target if target
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::EventDestination.new(client: self, result: result)
+        NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
       end
 
       ##
@@ -212,7 +236,7 @@ module NgrokAPI
         data[:format] = format if format
         data[:target] = target if target
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EventDestination.new(client: self, result: result)
+        NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/services/event_sources_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -30,7 +32,27 @@ module NgrokAPI
         data = {}
         data[:type] = type if type
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::EventSource.new(client: self, result: result)
+        NgrokAPI::Models::EventSource.new(client: self, attrs: result)
+      end
+
+      ##
+      # Add an additional type for which this event subscription will trigger
+      # Throws an exception if API error.
+      #
+      # @param [string] subscription_id The unique identifier for the Event Subscription that this Event Source is attached to.
+      # @param [string] type Type of event for which an event subscription will trigger
+      # @return [NgrokAPI::Models::EventSource] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-event-sources-create
+      def create!(subscription_id: "", type: "", filter: "", fields: [])
+        path = '/event_subscriptions/%{subscription_id}/sources'
+        replacements = {
+          subscription_id: subscription_id,
+        }
+        data = {}
+        data[:type] = type if type
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::EventSource.new(client: self, attrs: result)
       end
 
       ##
@@ -84,7 +106,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EventSource.new(client: self, result: result)
+        NgrokAPI::Models::EventSource.new(client: self, attrs: result)
       end
 
       ##
@@ -104,7 +126,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EventSource.new(client: self, result: result)
+        NgrokAPI::Models::EventSource.new(client: self, attrs: result)
       end
 
       ##
@@ -121,7 +143,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EventSourceList.new(client: self, result: result)
+        NgrokAPI::Models::EventSourceList.new(client: self, attrs: result)
       end
 
       ##
@@ -139,7 +161,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EventSourceList.new(client: self, result: result)
+        NgrokAPI::Models::EventSourceList.new(client: self, attrs: result)
       end
 
       ##
@@ -158,7 +180,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::EventSource.new(client: self, result: result)
+        NgrokAPI::Models::EventSource.new(client: self, attrs: result)
       end
 
       ##
@@ -178,7 +200,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EventSource.new(client: self, result: result)
+        NgrokAPI::Models::EventSource.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/services/event_subscriptions_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -36,7 +38,31 @@ module NgrokAPI
         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)
+        NgrokAPI::Models::EventSubscription.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create an Event Subscription.
+      # Throws an exception if API error.
+      #
+      # @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 Subscription.
+      # @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, danger: true)
+        NgrokAPI::Models::EventSubscription.new(client: self, attrs: result)
       end
 
       ##
@@ -84,7 +110,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EventSubscription.new(client: self, result: result)
+        NgrokAPI::Models::EventSubscription.new(client: self, attrs: result)
       end
 
       ##
@@ -102,7 +128,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EventSubscription.new(client: self, result: result)
+        NgrokAPI::Models::EventSubscription.new(client: self, attrs: result)
       end
 
       ##
@@ -114,8 +140,7 @@ module NgrokAPI
       # @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)
+      def list(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -125,7 +150,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::EventSubscription
         )
@@ -141,8 +166,7 @@ module NgrokAPI
       # @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)
+      def list!(before_id: nil, limit: nil, url: nil)
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -153,7 +177,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::EventSubscription,
           danger: true
@@ -182,7 +206,7 @@ module NgrokAPI
         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)
+        NgrokAPI::Models::EventSubscription.new(client: self, attrs: result)
       end
 
       ##
@@ -208,7 +232,7 @@ module NgrokAPI
         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)
+        NgrokAPI::Models::EventSubscription.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/services/failover_backends_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -39,11 +41,33 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:backends] = backends if backends
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::FailoverBackend.new(client: self, result: result)
+        NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new Failover backend
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [List<string>] backends the ids of the child backends in order
+      # @return [NgrokAPI::Models::FailoverBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-failover-backends-create
+      def create!(description: "", metadata: "", backends: [])
+        path = '/backends/failover'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:backends] = backends if backends
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
       end
 
       ##
-      # Delete a Failover backend by ID. TODO what if used?
+      # Delete a Failover backend by ID.
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
@@ -58,7 +82,7 @@ module NgrokAPI
       end
 
       ##
-      # Delete a Failover backend by ID. TODO what if used?
+      # Delete a Failover backend by ID.
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier
@@ -87,7 +111,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::FailoverBackend.new(client: self, result: result)
+        NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
       end
 
       ##
@@ -105,7 +129,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::FailoverBackend.new(client: self, result: result)
+        NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
       end
 
       ##
@@ -117,8 +141,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-failover-backends-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 +151,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::FailoverBackend
         )
@@ -144,8 +167,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-failover-backends-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 +178,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::FailoverBackend,
           danger: true
@@ -183,7 +205,7 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:backends] = backends if backends
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::FailoverBackend.new(client: self, result: result)
+        NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
       end
 
       ##
@@ -207,7 +229,7 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:backends] = backends if backends
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::FailoverBackend.new(client: self, result: result)
+        NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
       end
     end
   end