ngrok-api 0.16.0 → 0.19.0

data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Services
-    ##
-    # https://ngrok.com/docs/api#api-endpoint-webhook-validation-module
-    class EndpointWebhookValidationModuleClient
-      # The API path for the requests
-      PATH = '/endpoint_configurations/%{id}/webhook_validation'
-
-      attr_reader :client
-
-      def initialize(client:)
-        @client = client
-      end
-
-      ##
-      # @param [string] id
-      # @param [EndpointWebhookValidation] a_module
-      # @return [NgrokAPI::Models::EndpointWebhookValidation] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-replace
-      def replace(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/webhook_validation'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        data[:module] = a_module if a_module
-        result = @client.put(path % replacements, data: data)
-        NgrokAPI::Models::EndpointWebhookValidation.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id
-      # @param [EndpointWebhookValidation] a_module
-      # @return [NgrokAPI::Models::EndpointWebhookValidation] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-replace
-      def replace!(id: "", a_module: nil)
-        path = '/endpoint_configurations/%{id}/webhook_validation'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        data[:module] = a_module if a_module
-        result = @client.put(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointWebhookValidation.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointWebhookValidation] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-get
-      def get(id: "")
-        path = '/endpoint_configurations/%{id}/webhook_validation'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EndpointWebhookValidation.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EndpointWebhookValidation] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-get
-      def get!(id: "")
-        path = '/endpoint_configurations/%{id}/webhook_validation'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EndpointWebhookValidation.new(client: self, result: result)
-      end
-
-      ##
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::Empty] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-delete
-      def delete(id: "")
-        path = '/endpoint_configurations/%{id}/webhook_validation'
-        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-endpoint-webhook-validation-module-delete
-      def delete!(id: "")
-        path = '/endpoint_configurations/%{id}/webhook_validation'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements, danger: true)
-      end
-    end
-  end
-end

data/lib/ngrokapi/services/event_streams_client.rb

@@ -1,224 +0,0 @@
-# frozen_string_literal: true
-
-module NgrokAPI
-  module Services
-    ##
-    # https://ngrok.com/docs/api#api-event-streams
-    class EventStreamsClient
-      # The API path for the requests
-      PATH = '/event_streams'
-      # The List Property from the resulting API for list calls
-      LIST_PROPERTY = 'event_streams'
-
-      attr_reader :client
-
-      def initialize(client:)
-        @client = client
-      end
-
-      ##
-      # Create a new Event Stream. It will not apply to anything until you associate it
-      # with one or more Endpoint Configs.
-      #
-      # @param [string] metadata Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.
-      # @param [string] description Human-readable description of the Event Stream. Optional, max 255 bytes.
-      # @param [List<string>] fields A list of protocol-specific fields you want to collect on each event.
-      # @param [string] event_type The protocol that determines which events will be collected. Supported values are ``tcp_connection_closed`` and ``http_request_complete``.
-      # @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 [float64] sampling_rate The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.
-      # @return [NgrokAPI::Models::EventStream] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-event-streams-create
-      def create(metadata: "", description: "", fields: [], event_type: "", destination_ids: [], sampling_rate: 0)
-        path = '/event_streams'
-        replacements = {
-        }
-        data = {}
-        data[:metadata] = metadata if metadata
-        data[:description] = description if description
-        data[:fields] = fields if fields
-        data[:event_type] = event_type if event_type
-        data[:destination_ids] = destination_ids if destination_ids
-        data[:sampling_rate] = sampling_rate if sampling_rate
-        result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::EventStream.new(client: self, result: result)
-      end
-
-      ##
-      # Delete an Event Stream. Associated Event Destinations will be preserved.
-      #
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::Empty] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-event-streams-delete
-      def delete(id: "")
-        path = '/event_streams/%{id}'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements)
-      end
-
-      ##
-      # Delete an Event Stream. Associated Event Destinations will be preserved.
-      # 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-streams-delete
-      def delete!(id: "")
-        path = '/event_streams/%{id}'
-        replacements = {
-          id: id,
-        }
-        @client.delete(path % replacements, danger: true)
-      end
-
-      ##
-      # Get detailed information about an Event Stream by ID.
-      #
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EventStream] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-event-streams-get
-      def get(id: "")
-        path = '/event_streams/%{id}'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::EventStream.new(client: self, result: result)
-      end
-
-      ##
-      # Get detailed information about an Event Stream by ID.
-      # Throws an exception if API error.
-      #
-      # @param [string] id a resource identifier
-      # @return [NgrokAPI::Models::EventStream] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-event-streams-get
-      def get!(id: "")
-        path = '/event_streams/%{id}'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EventStream.new(client: self, result: result)
-      end
-
-      ##
-      # List all Event Streams available 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-event-streams-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::EventStream
-        )
-      end
-
-      ##
-      # List all Event Streams available 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-event-streams-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,
-          result: result,
-          list_property: LIST_PROPERTY,
-          klass: NgrokAPI::Models::EventStream,
-          danger: true
-        )
-      end
-
-      ##
-      # Update attributes of an Event Stream by ID.
-      #
-      # @param [string] id Unique identifier for this Event Stream.
-      # @param [string] metadata Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.
-      # @param [string] description Human-readable description of the Event Stream. Optional, max 255 bytes.
-      # @param [List<string>] fields A list of protocol-specific fields you want to collect on each event.
-      # @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 [float64] sampling_rate The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.
-      # @return [NgrokAPI::Models::EventStream] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-event-streams-update
-      def update(id: "", metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil)
-        path = '/event_streams/%{id}'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        data[:metadata] = metadata if metadata
-        data[:description] = description if description
-        data[:fields] = fields if fields
-        data[:destination_ids] = destination_ids if destination_ids
-        data[:sampling_rate] = sampling_rate if sampling_rate
-        result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::EventStream.new(client: self, result: result)
-      end
-
-      ##
-      # Update attributes of an Event Stream by ID.
-      # Throws an exception if API error.
-      #
-      # @param [string] id Unique identifier for this Event Stream.
-      # @param [string] metadata Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.
-      # @param [string] description Human-readable description of the Event Stream. Optional, max 255 bytes.
-      # @param [List<string>] fields A list of protocol-specific fields you want to collect on each event.
-      # @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 [float64] sampling_rate The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.
-      # @return [NgrokAPI::Models::EventStream] result from the API request
-      #
-      # https://ngrok.com/docs/api#api-event-streams-update
-      def update!(id: "", metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil)
-        path = '/event_streams/%{id}'
-        replacements = {
-          id: id,
-        }
-        data = {}
-        data[:metadata] = metadata if metadata
-        data[:description] = description if description
-        data[:fields] = fields if fields
-        data[:destination_ids] = destination_ids if destination_ids
-        data[:sampling_rate] = sampling_rate if sampling_rate
-        result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::EventStream.new(client: self, result: result)
-      end
-    end
-  end
-end

data/spec/ngrokapi/models/endpoint_configuration_spec.rb

@@ -1,78 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe NgrokAPI::Models::EndpointConfiguration do
-  before(:each) do
-    @client = class_double("EndpointConfigurationsClient")
-    @endpoint_configuration = NgrokAPI::Models::EndpointConfiguration.new(client: @client, result: endpoint_configuration_result)
-  end
-
-  describe "#==" do
-    it "is equal if the results are the same" do
-      other = NgrokAPI::Models::EndpointConfiguration.new(client: @client, result: endpoint_configuration_result)
-      expect(@endpoint_configuration == other).to eq true
-    end
-  end
-
-  describe "#to_s" do
-    it "stringifies as result.to_s" do
-      expect(@endpoint_configuration.to_s).to eq endpoint_configuration_result.to_s
-    end
-  end
-
-  describe "#delete" do
-    it "calls delete on the client" do
-      expect(@endpoint_configuration.client).to receive(:delete)
-      @endpoint_configuration.delete
-    end
-  end
-
-  describe "#update" do
-    it "calls update on the client" do
-      new_description = 'New description'
-      new_metadata = 'New metadata'
-      new_circuit_breaker = 'New circuit_breaker'
-      new_compression = 'New compression'
-      new_request_headers = 'New request_headers'
-      new_response_headers = 'New response_headers'
-      new_ip_policy = 'New ip_policy'
-      new_mutual_tls = 'New mutual_tls'
-      new_tls_termination = 'New tls_termination'
-      new_webhook_validation = 'New webhook_validation'
-      new_oauth = 'New oauth'
-      new_logging = 'New logging'
-      new_saml = 'New saml'
-      new_oidc = 'New oidc'
-      expect(@endpoint_configuration.client).to receive(:update)
-      @endpoint_configuration.update(
-        description: new_description,
-        metadata: new_metadata,
-        circuit_breaker: new_circuit_breaker,
-        compression: new_compression,
-        request_headers: new_request_headers,
-        response_headers: new_response_headers,
-        ip_policy: new_ip_policy,
-        mutual_tls: new_mutual_tls,
-        tls_termination: new_tls_termination,
-        webhook_validation: new_webhook_validation,
-        oauth: new_oauth,
-        logging: new_logging,
-        saml: new_saml,
-        oidc: new_oidc
-      )
-      expect(@endpoint_configuration.description).to eq new_description
-      expect(@endpoint_configuration.metadata).to eq new_metadata
-      expect(@endpoint_configuration.circuit_breaker).to eq new_circuit_breaker
-      expect(@endpoint_configuration.compression).to eq new_compression
-      expect(@endpoint_configuration.request_headers).to eq new_request_headers
-      expect(@endpoint_configuration.response_headers).to eq new_response_headers
-      expect(@endpoint_configuration.ip_policy).to eq new_ip_policy
-      expect(@endpoint_configuration.mutual_tls).to eq new_mutual_tls
-      expect(@endpoint_configuration.tls_termination).to eq new_tls_termination
-      expect(@endpoint_configuration.webhook_validation).to eq new_webhook_validation
-      expect(@endpoint_configuration.oauth).to eq new_oauth
-      expect(@endpoint_configuration.logging).to eq new_logging
-      expect(@endpoint_configuration.saml).to eq new_saml
-      expect(@endpoint_configuration.oidc).to eq new_oidc
-    end
-  end
-end

data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb

@@ -1,21 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe NgrokAPI::Models::EndpointLoggingMutate do
-  before(:each) do
-    @client = class_double("EndpointLoggingMutatesClient")
-    @endpoint_logging_mutate = NgrokAPI::Models::EndpointLoggingMutate.new(client: @client, result: endpoint_logging_mutate_result)
-  end
-
-  describe "#==" do
-    it "is equal if the results are the same" do
-      other = NgrokAPI::Models::EndpointLoggingMutate.new(client: @client, result: endpoint_logging_mutate_result)
-      expect(@endpoint_logging_mutate == other).to eq true
-    end
-  end
-
-  describe "#to_s" do
-    it "stringifies as result.to_s" do
-      expect(@endpoint_logging_mutate.to_s).to eq endpoint_logging_mutate_result.to_s
-    end
-  end
-end

data/spec/ngrokapi/models/endpoint_logging_spec.rb

@@ -1,21 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe NgrokAPI::Models::EndpointLogging do
-  before(:each) do
-    @client = class_double("EndpointLoggingsClient")
-    @endpoint_logging = NgrokAPI::Models::EndpointLogging.new(client: @client, result: endpoint_logging_result)
-  end
-
-  describe "#==" do
-    it "is equal if the results are the same" do
-      other = NgrokAPI::Models::EndpointLogging.new(client: @client, result: endpoint_logging_result)
-      expect(@endpoint_logging == other).to eq true
-    end
-  end
-
-  describe "#to_s" do
-    it "stringifies as result.to_s" do
-      expect(@endpoint_logging.to_s).to eq endpoint_logging_result.to_s
-    end
-  end
-end

data/spec/ngrokapi/models/event_stream_spec.rb

@@ -1,51 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe NgrokAPI::Models::EventStream do
-  before(:each) do
-    @client = class_double("EventStreamsClient")
-    @event_stream = NgrokAPI::Models::EventStream.new(client: @client, result: event_stream_result)
-  end
-
-  describe "#==" do
-    it "is equal if the results are the same" do
-      other = NgrokAPI::Models::EventStream.new(client: @client, result: event_stream_result)
-      expect(@event_stream == other).to eq true
-    end
-  end
-
-  describe "#to_s" do
-    it "stringifies as result.to_s" do
-      expect(@event_stream.to_s).to eq event_stream_result.to_s
-    end
-  end
-
-  describe "#delete" do
-    it "calls delete on the client" do
-      expect(@event_stream.client).to receive(:delete)
-      @event_stream.delete
-    end
-  end
-
-  describe "#update" do
-    it "calls update on the client" do
-      new_metadata = 'New metadata'
-      new_description = 'New description'
-      new_fields = 'New fields'
-      new_destination_ids = 'New destination_ids'
-      new_sampling_rate = 'New sampling_rate'
-      expect(@event_stream.client).to receive(:update)
-      @event_stream.update(
-        metadata: new_metadata,
-        description: new_description,
-        fields: new_fields,
-        destination_ids: new_destination_ids,
-        sampling_rate: new_sampling_rate
-      )
-      expect(@event_stream.metadata).to eq new_metadata
-      expect(@event_stream.description).to eq new_description
-      expect(@event_stream.fields).to eq new_fields
-      expect(@event_stream.destination_ids).to eq new_destination_ids
-      expect(@event_stream.sampling_rate).to eq new_sampling_rate
-    end
-  end
-end