ngrok-api 0.9.0 → 0.12.0

data/lib/ngrokapi/models/credential.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class Credential
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :token,
+        :acl
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @token = @result['token']
+        @acl = @result['acl']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete a tunnel authtoken credential by ID
+      #
+      # https://ngrok.com/docs/api#api-credentials-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of an tunnel authtoken credential by ID
+      #
+      # https://ngrok.com/docs/api#api-credentials-update
+      def update(
+        description: nil,
+        metadata: nil,
+        acl: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @acl = acl if acl
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          acl: acl
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_circuit_breaker.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointCircuitBreaker
+      attr_reader :client,
+        :result,
+        :enabled,
+        :tripped_duration,
+        :rolling_window,
+        :num_buckets,
+        :volume_threshold,
+        :error_threshold_percentage
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @tripped_duration = @result['tripped_duration']
+        @rolling_window = @result['rolling_window']
+        @num_buckets = @result['num_buckets']
+        @volume_threshold = @result['volume_threshold']
+        @error_threshold_percentage = @result['error_threshold_percentage']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_compression.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointCompression
+      attr_reader :client,
+        :result,
+        :enabled
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_configuration.rb

@@ -1,119 +1,130 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Models
-    ##
-    # A resource representing data from the endpoint_configuration API
-    class EndpointConfiguration
-      attr_reader :id,
-        :client,
-        :created_at,
-        :description,
-        :metadata,
-        :result,
-        :uri
-
-      def initialize(client:, result:)
-        @client = client
-        @result = result
-        @created_at = @result['created_at']
-        @id = @result['id']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @uri = @result['uri']
-      end
-
-      def ==(other)
-        @result == other.result
-      end
-
-      def to_s
-        @result.to_s
-      end
-
-      ##
-      # Delete this endpoint configuration.
-      #
-      # @return [nil] result from delete request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-configurations-delete
-      def delete
-        @client.delete(id: @id)
-      end
-
-      # rubocop:disable LineLength
-
-      ##
-      # Update this endpoint configuration. If a module is not specified in the update, it will not be modified.
-      # However, each module configuration that is specified will completely replace the existing value.
-      # There is no way to delete an existing module via this API, instead use the delete module API.
-      #
-      # @param [string] description human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
-      # @param [string] metadata arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
-      # @param [string] circuit_breaker circuit breaker module configuration
-      # @param [string] compression compression module configuration
-      # @param [string] request_headers request headers module configuration
-      # @param [string] response_headers response headers module configuration
-      # @param [string] ip_policy ip policy module configuration
-      # @param [string] mutual_tls mutual TLS module configuration
-      # @param [string] tls_termination TLS termination module configuration
-      # @param [string] webhook_validation webhook validation module configuration
-      # @param [string] oauth oauth module configuration
-      # @param [string] logging logging module configuration
-      # @param [string] saml saml module configuration
-      # @param [string] oidc oidc module configuration
-      # @return [NgrokAPI::Models::EndpointConfiguration] result from update request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-configurations-update
-      def update(
-        description: nil,
-        metadata: nil,
-        circuit_breaker: nil,
-        compression: nil,
-        request_headers: nil,
-        response_headers: nil,
-        ip_policy: nil,
-        mutual_tls: nil,
-        tls_termination: nil,
-        webhook_validation: nil,
-        oauth: nil,
-        logging: nil,
-        saml: nil,
-        oidc: nil
-      )
-        @description = description if description
-        @metadata = metadata if metadata
-        @circuit_breaker = circuit_breaker if circuit_breaker
-        @compression = compression if compression
-        @request_headers = request_headers if request_headers
-        @response_headers = response_headers if response_headers
-        @ip_policy = ip_policy if ip_policy
-        @mutual_tls = mutual_tls if mutual_tls
-        @tls_termination = tls_termination if tls_termination
-        @webhook_validation = webhook_validation if webhook_validation
-        @oauth = oauth if oauth
-        @logging = logging if logging
-        @saml = saml if saml
-        @oidc = oidc if oidc
-        @client.update(
-          id: @id,
-          description: description,
-          metadata: metadata,
-          circuit_breaker: circuit_breaker,
-          compression: compression,
-          request_headers: request_headers,
-          response_headers: response_headers,
-          ip_policy: ip_policy,
-          mutual_tls: mutual_tls,
-          tls_termination: tls_termination,
-          webhook_validation: webhook_validation,
-          oauth: oauth,
-          logging: logging,
-          saml: saml,
-          oidc: oidc
-        )
-      end
-      # rubocop:enable LineLength
-    end
-  end
-end
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointConfiguration
+      attr_reader :client,
+        :result,
+        :id,
+        :type,
+        :description,
+        :metadata,
+        :created_at,
+        :uri,
+        :basic_auth,
+        :circuit_breaker,
+        :compression,
+        :request_headers,
+        :response_headers,
+        :ip_policy,
+        :mutual_tls,
+        :tls_termination,
+        :webhook_validation,
+        :oauth,
+        :logging,
+        :saml,
+        :oidc,
+        :backend
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @type = @result['type']
+        @description = @result['description']
+        @metadata = @result['metadata']
+        @created_at = @result['created_at']
+        @uri = @result['uri']
+        @basic_auth = @result['basic_auth']
+        @circuit_breaker = @result['circuit_breaker']
+        @compression = @result['compression']
+        @request_headers = @result['request_headers']
+        @response_headers = @result['response_headers']
+        @ip_policy = @result['ip_policy']
+        @mutual_tls = @result['mutual_tls']
+        @tls_termination = @result['tls_termination']
+        @webhook_validation = @result['webhook_validation']
+        @oauth = @result['oauth']
+        @logging = @result['logging']
+        @saml = @result['saml']
+        @oidc = @result['oidc']
+        @backend = @result['backend']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an endpoint configuration. This operation will fail if the endpoint
+      # configuration is still referenced by any reserved domain or reserved address.
+      #
+      # https://ngrok.com/docs/api#api-endpoint-configurations-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Updates an endpoint configuration. If a module is not specified in the update,
+      # it will not be modified. However, each module configuration that is specified
+      # will completely replace the existing value. There is no way to delete an
+      # existing module via this API, instead use the delete module API.
+      #
+      # https://ngrok.com/docs/api#api-endpoint-configurations-update
+      def update(
+        description: nil,
+        metadata: nil,
+        circuit_breaker: nil,
+        compression: nil,
+        request_headers: nil,
+        response_headers: nil,
+        ip_policy: nil,
+        mutual_tls: nil,
+        tls_termination: nil,
+        webhook_validation: nil,
+        oauth: nil,
+        logging: nil,
+        saml: nil,
+        oidc: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @circuit_breaker = circuit_breaker if circuit_breaker
+        @compression = compression if compression
+        @request_headers = request_headers if request_headers
+        @response_headers = response_headers if response_headers
+        @ip_policy = ip_policy if ip_policy
+        @mutual_tls = mutual_tls if mutual_tls
+        @tls_termination = tls_termination if tls_termination
+        @webhook_validation = webhook_validation if webhook_validation
+        @oauth = oauth if oauth
+        @logging = logging if logging
+        @saml = saml if saml
+        @oidc = oidc if oidc
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          circuit_breaker: circuit_breaker,
+          compression: compression,
+          request_headers: request_headers,
+          response_headers: response_headers,
+          ip_policy: ip_policy,
+          mutual_tls: mutual_tls,
+          tls_termination: tls_termination,
+          webhook_validation: webhook_validation,
+          oauth: oauth,
+          logging: logging,
+          saml: saml,
+          oidc: oidc
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_ip_policy.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointIPPolicy
+      attr_reader :client,
+        :result,
+        :enabled,
+        :ip_policies
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @ip_policies = @result['ip_policies']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointIPPolicyMutate
+      attr_reader :client,
+        :result,
+        :enabled,
+        :ip_policy_ids
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @ip_policy_ids = @result['ip_policy_ids']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_logging.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointLogging
+      attr_reader :client,
+        :result,
+        :enabled,
+        :event_streams
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @event_streams = @result['event_streams']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_logging_mutate.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointLoggingMutate
+      attr_reader :client,
+        :result,
+        :enabled,
+        :event_stream_ids
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @event_stream_ids = @result['event_stream_ids']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_mutual_tls.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointMutualTLS
+      attr_reader :client,
+        :result,
+        :enabled,
+        :certificate_authorities
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @certificate_authorities = @result['certificate_authorities']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointMutualTLSMutate
+      attr_reader :client,
+        :result,
+        :enabled,
+        :certificate_authority_ids
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @certificate_authority_ids = @result['certificate_authority_ids']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_o_auth.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointOAuth
+      attr_reader :client,
+        :result,
+        :enabled,
+        :provider,
+        :options_passthrough,
+        :cookie_prefix,
+        :inactivity_timeout,
+        :maximum_duration,
+        :auth_check_interval
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @provider = @result['provider']
+        @options_passthrough = @result['options_passthrough']
+        @cookie_prefix = @result['cookie_prefix']
+        @inactivity_timeout = @result['inactivity_timeout']
+        @maximum_duration = @result['maximum_duration']
+        @auth_check_interval = @result['auth_check_interval']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointOAuthFacebook
+      attr_reader :client,
+        :result,
+        :client_id,
+        :client_secret,
+        :scopes,
+        :email_addresses,
+        :email_domains
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @client_id = @result['client_id']
+        @client_secret = @result['client_secret']
+        @scopes = @result['scopes']
+        @email_addresses = @result['email_addresses']
+        @email_domains = @result['email_domains']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointOAuthGitHub
+      attr_reader :client,
+        :result,
+        :client_id,
+        :client_secret,
+        :scopes,
+        :email_addresses,
+        :email_domains,
+        :teams,
+        :organizations
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @client_id = @result['client_id']
+        @client_secret = @result['client_secret']
+        @scopes = @result['scopes']
+        @email_addresses = @result['email_addresses']
+        @email_domains = @result['email_domains']
+        @teams = @result['teams']
+        @organizations = @result['organizations']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end