ngrok-api 0.9.0 → 0.12.0

data/lib/ngrokapi/models/endpoint_o_auth_google.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointOAuthGoogle
+      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_microsoft.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointOAuthMicrosoft
+      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_provider.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointOAuthProvider
+      attr_reader :client,
+        :result,
+        :github,
+        :facebook,
+        :microsoft,
+        :google
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @github = @result['github']
+        @facebook = @result['facebook']
+        @microsoft = @result['microsoft']
+        @google = @result['google']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_oidc.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointOIDC
+      attr_reader :client,
+        :result,
+        :enabled,
+        :options_passthrough,
+        :cookie_prefix,
+        :inactivity_timeout,
+        :maximum_duration,
+        :issuer,
+        :client_id,
+        :client_secret,
+        :scopes
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @options_passthrough = @result['options_passthrough']
+        @cookie_prefix = @result['cookie_prefix']
+        @inactivity_timeout = @result['inactivity_timeout']
+        @maximum_duration = @result['maximum_duration']
+        @issuer = @result['issuer']
+        @client_id = @result['client_id']
+        @client_secret = @result['client_secret']
+        @scopes = @result['scopes']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_request_headers.rb

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

data/lib/ngrokapi/models/endpoint_response_headers.rb

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

data/lib/ngrokapi/models/endpoint_saml.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointSAML
+      attr_reader :client,
+        :result,
+        :enabled,
+        :options_passthrough,
+        :cookie_prefix,
+        :inactivity_timeout,
+        :maximum_duration,
+        :idp_metadata_url,
+        :idp_metadata,
+        :force_authn,
+        :allow_idp_initiated,
+        :authorized_groups,
+        :entity_id,
+        :assertion_consumer_service_url,
+        :single_logout_url,
+        :request_signing_certificate_pem,
+        :metadata_url,
+        :nameid_format
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @options_passthrough = @result['options_passthrough']
+        @cookie_prefix = @result['cookie_prefix']
+        @inactivity_timeout = @result['inactivity_timeout']
+        @maximum_duration = @result['maximum_duration']
+        @idp_metadata_url = @result['idp_metadata_url']
+        @idp_metadata = @result['idp_metadata']
+        @force_authn = @result['force_authn']
+        @allow_idp_initiated = @result['allow_idp_initiated']
+        @authorized_groups = @result['authorized_groups']
+        @entity_id = @result['entity_id']
+        @assertion_consumer_service_url = @result['assertion_consumer_service_url']
+        @single_logout_url = @result['single_logout_url']
+        @request_signing_certificate_pem = @result['request_signing_certificate_pem']
+        @metadata_url = @result['metadata_url']
+        @nameid_format = @result['nameid_format']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_saml_mutate.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EndpointSAMLMutate
+      attr_reader :client,
+        :result,
+        :enabled,
+        :options_passthrough,
+        :cookie_prefix,
+        :inactivity_timeout,
+        :maximum_duration,
+        :idp_metadata_url,
+        :idp_metadata,
+        :force_authn,
+        :allow_idp_initiated,
+        :authorized_groups,
+        :nameid_format
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @enabled = @result['enabled']
+        @options_passthrough = @result['options_passthrough']
+        @cookie_prefix = @result['cookie_prefix']
+        @inactivity_timeout = @result['inactivity_timeout']
+        @maximum_duration = @result['maximum_duration']
+        @idp_metadata_url = @result['idp_metadata_url']
+        @idp_metadata = @result['idp_metadata']
+        @force_authn = @result['force_authn']
+        @allow_idp_initiated = @result['allow_idp_initiated']
+        @authorized_groups = @result['authorized_groups']
+        @nameid_format = @result['nameid_format']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_tls_termination.rb

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

data/lib/ngrokapi/models/endpoint_webhook_validation.rb

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

data/lib/ngrokapi/models/event_destination.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EventDestination
+      attr_reader :client,
+        :result,
+        :id,
+        :metadata,
+        :created_at,
+        :description,
+        :format,
+        :target,
+        :uri
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @metadata = @result['metadata']
+        @created_at = @result['created_at']
+        @description = @result['description']
+        @format = @result['format']
+        @target = @result['target']
+        @uri = @result['uri']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an Event Destination. If the Event Destination is still referenced by an
+      # Event Stream, this will throw an error until that Event Stream has removed that
+      # reference.
+      #
+      # https://ngrok.com/docs/api#api-event-destinations-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/event_source.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EventSource
+      attr_reader :client,
+        :result,
+        :type,
+        :filter,
+        :fields,
+        :uri
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @type = @result['type']
+        @filter = @result['filter']
+        @fields = @result['fields']
+        @uri = @result['uri']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/event_source_replace.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EventSourceReplace
+      attr_reader :client,
+        :result,
+        :type,
+        :filter,
+        :fields
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @type = @result['type']
+        @filter = @result['filter']
+        @fields = @result['fields']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/event_stream.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EventStream
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :metadata,
+        :description,
+        :fields,
+        :event_type,
+        :destination_ids,
+        :sampling_rate
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @metadata = @result['metadata']
+        @description = @result['description']
+        @fields = @result['fields']
+        @event_type = @result['event_type']
+        @destination_ids = @result['destination_ids']
+        @sampling_rate = @result['sampling_rate']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an Event Stream. Associated Event Destinations will be preserved.
+      #
+      # https://ngrok.com/docs/api#api-event-streams-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of an Event Stream by ID.
+      #
+      # https://ngrok.com/docs/api#api-event-streams-update
+      def update(
+        metadata: nil,
+        description: nil,
+        fields: nil,
+        destination_ids: nil,
+        sampling_rate: nil
+      )
+        @metadata = metadata if metadata
+        @description = description if description
+        @fields = fields if fields
+        @destination_ids = destination_ids if destination_ids
+        @sampling_rate = sampling_rate if sampling_rate
+        @client.update(
+          id: @id,
+          metadata: metadata,
+          description: description,
+          fields: fields,
+          destination_ids: destination_ids,
+          sampling_rate: sampling_rate
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/event_subscription.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EventSubscription
+      attr_reader :client,
+        :result,
+        :id,
+        :uri,
+        :created_at,
+        :metadata,
+        :description,
+        :sources,
+        :destinations
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @id = @result['id']
+        @uri = @result['uri']
+        @created_at = @result['created_at']
+        @metadata = @result['metadata']
+        @description = @result['description']
+        @sources = @result['sources']
+        @destinations = @result['destinations']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+
+      ##
+      # Delete an Event Subscription.
+      #
+      # https://ngrok.com/docs/api#api-event-subscriptions-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/event_target.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module NgrokAPI
+  module Models
+    class EventTarget
+      attr_reader :client,
+        :result,
+        :firehose,
+        :kinesis,
+        :cloudwatch_logs,
+        :debug
+
+      def initialize(client:, result:)
+        @client = client
+        @result = result
+        @firehose = @result['firehose']
+        @kinesis = @result['kinesis']
+        @cloudwatch_logs = @result['cloudwatch_logs']
+        @debug = @result['debug']
+      end
+
+      def ==(other)
+        @result == other.result
+      end
+
+      def to_s
+        @result.to_s
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb

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

data/lib/ngrokapi/models/event_target_firehose.rb

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