ngrok-api 0.16.0 → 0.19.0

data/lib/ngrokapi/services/event_subscriptions_client.rb

@@ -22,7 +22,7 @@ module NgrokAPI
       # @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.
+      # @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
@@ -36,7 +36,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 +108,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 +126,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 +138,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 +148,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::EventSubscription
         )
@@ -141,8 +164,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 +175,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::EventSubscription,
           danger: true
@@ -167,7 +189,7 @@ module NgrokAPI
       # @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.
+      # @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-update
@@ -182,7 +204,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
 
       ##
@@ -193,7 +215,7 @@ module NgrokAPI
       # @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.
+      # @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-update
@@ -208,7 +230,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

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # A Failover backend defines failover behavior within a list of referenced
+    #  backends. Traffic is sent to the first backend in the list. If that backend
+    #  is offline or no connection can be established, ngrok attempts to connect to
+    #  the next backend in the list until one is successful.
+    #
+    # https://ngrok.com/docs/api#api-failover-backends
+    class FailoverBackendsClient
+      # The API path for the requests
+      PATH = '/backends/failover'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'backends'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # Create a new Failover backend
+      #
+      # @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)
+        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.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-failover-backends-delete
+      def delete(id: "")
+        path = '/backends/failover/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements)
+      end
+
+      ##
+      # Delete a Failover backend by ID.
+      # 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-failover-backends-delete
+      def delete!(id: "")
+        path = '/backends/failover/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # Get detailed information about a Failover backend by ID
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::FailoverBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-failover-backends-get
+      def get(id: "")
+        path = '/backends/failover/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Get detailed information about a Failover backend by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::FailoverBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-failover-backends-get
+      def get!(id: "")
+        path = '/backends/failover/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # List all Failover backends 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-failover-backends-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,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::FailoverBackend
+        )
+      end
+
+      ##
+      # List all Failover backends on this account
+      # Throws an exception if API error.
+      #
+      # @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-failover-backends-list
+      def list!(before_id: nil, limit: nil, url: nil)
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          danger: true,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::FailoverBackend,
+          danger: true
+        )
+      end
+
+      ##
+      # Update Failover backend by ID
+      #
+      # @param [string] id
+      # @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-update
+      def update(id: "", description: nil, metadata: nil, backends: [])
+        path = '/backends/failover/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:backends] = backends if backends
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Update Failover backend by ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id
+      # @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-update
+      def update!(id: "", description: nil, metadata: nil, backends: [])
+        path = '/backends/failover/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        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, attrs: result)
+      end
+    end
+  end
+end

data/lib/ngrokapi/services/http_response_backends_client.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Services
+    ##
+    # https://ngrok.com/docs/api#api-http-response-backends
+    class HTTPResponseBackendsClient
+      # The API path for the requests
+      PATH = '/backends/http_response'
+      # The List Property from the resulting API for list calls
+      LIST_PROPERTY = 'backends'
+
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      ##
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [string] body body to return as fixed content
+      # @param [Map<string, string>] headers headers to return
+      # @param [int32] status_code status code to return
+      # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-http-response-backends-create
+      def create(description: "", metadata: "", body: "", headers: {}, status_code: nil)
+        path = '/backends/http_response'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:body] = body if body
+        data[:headers] = headers if headers
+        data[:status_code] = status_code if status_code
+        result = @client.post(path % replacements, data: data)
+        NgrokAPI::Models::HTTPResponseBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [string] body body to return as fixed content
+      # @param [Map<string, string>] headers headers to return
+      # @param [int32] status_code status code to return
+      # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-http-response-backends-create
+      def create!(description: "", metadata: "", body: "", headers: {}, status_code: nil)
+        path = '/backends/http_response'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:body] = body if body
+        data[:headers] = headers if headers
+        data[:status_code] = status_code if status_code
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::HTTPResponseBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::Empty] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-http-response-backends-delete
+      def delete(id: "")
+        path = '/backends/http_response/%{id}'
+        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-http-response-backends-delete
+      def delete!(id: "")
+        path = '/backends/http_response/%{id}'
+        replacements = {
+          id: id,
+        }
+        @client.delete(path % replacements, danger: true)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-http-response-backends-get
+      def get(id: "")
+        path = '/backends/http_response/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data)
+        NgrokAPI::Models::HTTPResponseBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # @param [string] id a resource identifier
+      # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-http-response-backends-get
+      def get!(id: "")
+        path = '/backends/http_response/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        result = @client.get(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::HTTPResponseBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # @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-http-response-backends-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,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::HTTPResponseBackend
+        )
+      end
+
+      ##
+      # @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-http-response-backends-list
+      def list!(before_id: nil, limit: nil, url: nil)
+        result = @client.list(
+          before_id: before_id,
+          limit: limit,
+          danger: true,
+          url: url,
+          path: PATH
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          attrs: result,
+          list_property: LIST_PROPERTY,
+          klass: NgrokAPI::Models::HTTPResponseBackend,
+          danger: true
+        )
+      end
+
+      ##
+      # @param [string] id
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [string] body body to return as fixed content
+      # @param [Map<string, string>] headers headers to return
+      # @param [int32] status_code status code to return
+      # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-http-response-backends-update
+      def update(id: "", description: nil, metadata: nil, body: nil, headers: nil, status_code: nil)
+        path = '/backends/http_response/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:body] = body if body
+        data[:headers] = headers if headers
+        data[:status_code] = status_code if status_code
+        result = @client.patch(path % replacements, data: data)
+        NgrokAPI::Models::HTTPResponseBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # @param [string] id
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [string] body body to return as fixed content
+      # @param [Map<string, string>] headers headers to return
+      # @param [int32] status_code status code to return
+      # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-http-response-backends-update
+      def update!(id: "", description: nil, metadata: nil, body: nil, headers: nil, status_code: nil)
+        path = '/backends/http_response/%{id}'
+        replacements = {
+          id: id,
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:body] = body if body
+        data[:headers] = headers if headers
+        data[:status_code] = status_code if status_code
+        result = @client.patch(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::HTTPResponseBackend.new(client: self, attrs: result)
+      end
+    end
+  end
+end