ngrok-api 0.21.0 → 0.22.0

data/docs/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.34
+    &mdash; Documentation by YARD 0.9.36
   
 </title>
 
@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 24 20:57:26 2023 by
+  Generated on Tue Apr 30 20:26:13 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.34 (ruby-3.0.6).
+  0.9.36 (ruby-3.3.0).
 </div>
 
     </div>

data/lib/ngrokapi/client.rb

@@ -56,6 +56,10 @@ module NgrokAPI
       @_tunnel_sessions ||= NgrokAPI::Services::TunnelSessionsClient.new(client: @client)
     end
 
+    def bot_users
+      @_bot_users ||= NgrokAPI::Services::BotUsersClient.new(client: @client)
+    end
+
     ##
     # Certificate Authorities are x509 certificates that are used to sign other
     #  x509 certificates. Attach a Certificate Authority to the Mutual TLS module
@@ -218,6 +222,7 @@ module NgrokAPI
       ns = OpenStruct.new
       ns.failover = NgrokAPI::Services::FailoverBackendsClient.new(client: @client)
       ns.http_response = NgrokAPI::Services::HTTPResponseBackendsClient.new(client: @client)
+      ns.static_address = NgrokAPI::Services::StaticBackendsClient.new(client: @client)
       ns.tunnel_group = NgrokAPI::Services::TunnelGroupBackendsClient.new(client: @client)
       ns.weighted = NgrokAPI::Services::WeightedBackendsClient.new(client: @client)
 
@@ -249,6 +254,7 @@ module NgrokAPI
       ns.https_edge_route_saml = NgrokAPI::Services::EdgeRouteSAMLModuleClient.new(client: @client)
       ns.https_edge_route_oidc = NgrokAPI::Services::EdgeRouteOIDCModuleClient.new(client: @client)
       ns.https_edge_route_websocket_tcp_converter = NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient.new(client: @client)
+      ns.https_edge_route_user_agent_filter = NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient.new(client: @client)
       ns.tcp_edge_backend = NgrokAPI::Services::TCPEdgeBackendModuleClient.new(client: @client)
       ns.tcp_edge_ip_restriction = NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient.new(client: @client)
       ns.tls_edge_backend = NgrokAPI::Services::TLSEdgeBackendModuleClient.new(client: @client)

data/lib/ngrokapi/models/bot_user.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
+module NgrokAPI
+  module Models
+    class BotUser
+      attr_reader :client,
+        :attrs,
+        :id,
+        :uri,
+        :name,
+        :active,
+        :created_at
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @id = @attrs['id']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
+        @name = @attrs['name']
+        @active = @attrs['active']
+        @created_at = @attrs['created_at']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+
+      ##
+      # Delete a bot user by ID
+      #
+      # https://ngrok.com/docs/api#api-bot-users-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of a bot user by ID.
+      #
+      # https://ngrok.com/docs/api#api-bot-users-update
+      def update(
+        name: nil,
+        active: nil
+      )
+        @name = name if name
+        @active = active if active
+        @client.update(
+          id: @id,
+          name: name,
+          active: active
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_action.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Models
+    class EndpointAction
+      attr_reader :client,
+        :attrs,
+        :type,
+        :config
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @type = @attrs['type']
+        @config = @attrs['config']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_policy.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Models
+    class EndpointPolicy
+      attr_reader :client,
+        :attrs,
+        :enabled,
+        :inbound,
+        :outbound
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @enabled = @attrs['enabled']
+        @inbound = @attrs['inbound']
+        @outbound = @attrs['outbound']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_rule.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Models
+    class EndpointRule
+      attr_reader :client,
+        :attrs,
+        :expressions,
+        :actions,
+        :name
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @expressions = @attrs['expressions']
+        @actions = @attrs['actions']
+        @name = @attrs['name']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/endpoint_saml.rb

@@ -14,7 +14,6 @@ module NgrokAPI
         :cookie_prefix,
         :inactivity_timeout,
         :maximum_duration,
-        :idp_metadata_url,
         :idp_metadata,
         :force_authn,
         :allow_idp_initiated,
@@ -34,9 +33,6 @@ module NgrokAPI
         @cookie_prefix = @attrs['cookie_prefix']
         @inactivity_timeout = @attrs['inactivity_timeout']
         @maximum_duration = @attrs['maximum_duration']
-        unless @attrs['idp_metadata_url'].nil?
-          @idp_metadata_url = URI(@attrs['idp_metadata_url'])
-        end
         @idp_metadata = @attrs['idp_metadata']
         @force_authn = @attrs['force_authn']
         @allow_idp_initiated = @attrs['allow_idp_initiated']

data/lib/ngrokapi/models/endpoint_saml_mutate.rb

@@ -14,7 +14,6 @@ module NgrokAPI
         :cookie_prefix,
         :inactivity_timeout,
         :maximum_duration,
-        :idp_metadata_url,
         :idp_metadata,
         :force_authn,
         :allow_idp_initiated,
@@ -29,9 +28,6 @@ module NgrokAPI
         @cookie_prefix = @attrs['cookie_prefix']
         @inactivity_timeout = @attrs['inactivity_timeout']
         @maximum_duration = @attrs['maximum_duration']
-        unless @attrs['idp_metadata_url'].nil?
-          @idp_metadata_url = URI(@attrs['idp_metadata_url'])
-        end
         @idp_metadata = @attrs['idp_metadata']
         @force_authn = @attrs['force_authn']
         @allow_idp_initiated = @attrs['allow_idp_initiated']

data/lib/ngrokapi/models/endpoint_user_agent_filter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Models
+    class EndpointUserAgentFilter
+      attr_reader :client,
+        :attrs,
+        :enabled,
+        :allow,
+        :deny
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @enabled = @attrs['enabled']
+        @allow = @attrs['allow']
+        @deny = @attrs['deny']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/event_source.rb

@@ -10,16 +10,12 @@ module NgrokAPI
       attr_reader :client,
         :attrs,
         :type,
-        :filter,
-        :fields,
         :uri
 
       def initialize(client: nil, attrs: {})
         @client = client
         @attrs = attrs
         @type = @attrs['type']
-        @filter = @attrs['filter']
-        @fields = @attrs['fields']
         unless @attrs['uri'].nil?
           @uri = URI(@attrs['uri'])
         end

data/lib/ngrokapi/models/event_source_replace.rb

@@ -7,16 +7,12 @@ module NgrokAPI
     class EventSourceReplace
       attr_reader :client,
         :attrs,
-        :type,
-        :filter,
-        :fields
+        :type
 
       def initialize(client: nil, attrs: {})
         @client = client
         @attrs = attrs
         @type = @attrs['type']
-        @filter = @attrs['filter']
-        @fields = @attrs['fields']
       end
 
       def ==(other)

data/lib/ngrokapi/models/event_target.rb

@@ -10,7 +10,6 @@ module NgrokAPI
         :firehose,
         :kinesis,
         :cloudwatch_logs,
-        :debug,
         :datadog
 
       def initialize(client: nil, attrs: {})
@@ -19,7 +18,6 @@ module NgrokAPI
         @firehose = @attrs['firehose']
         @kinesis = @attrs['kinesis']
         @cloudwatch_logs = @attrs['cloudwatch_logs']
-        @debug = @attrs['debug']
         @datadog = @attrs['datadog']
       end
 

data/lib/ngrokapi/models/https_edge_route.rb

@@ -27,7 +27,9 @@ module NgrokAPI
         :oauth,
         :saml,
         :oidc,
-        :websocket_tcp_converter
+        :websocket_tcp_converter,
+        :user_agent_filter,
+        :policy
 
       def initialize(client: nil, attrs: {})
         @client = client
@@ -53,6 +55,8 @@ module NgrokAPI
         @saml = @attrs['saml']
         @oidc = @attrs['oidc']
         @websocket_tcp_converter = @attrs['websocket_tcp_converter']
+        @user_agent_filter = @attrs['user_agent_filter']
+        @policy = @attrs['policy']
       end
 
       def ==(other)
@@ -89,7 +93,9 @@ module NgrokAPI
         oauth: nil,
         saml: nil,
         oidc: nil,
-        websocket_tcp_converter: nil
+        websocket_tcp_converter: nil,
+        user_agent_filter: nil,
+        policy: nil
       )
         @match_type = match_type if match_type
         @match = match if match
@@ -106,6 +112,8 @@ module NgrokAPI
         @saml = saml if saml
         @oidc = oidc if oidc
         @websocket_tcp_converter = websocket_tcp_converter if websocket_tcp_converter
+        @user_agent_filter = user_agent_filter if user_agent_filter
+        @policy = policy if policy
         @client.update(
           edge_id: @edge_id,
           id: @id,
@@ -123,7 +131,9 @@ module NgrokAPI
           oauth: oauth,
           saml: saml,
           oidc: oidc,
-          websocket_tcp_converter: websocket_tcp_converter
+          websocket_tcp_converter: websocket_tcp_converter,
+          user_agent_filter: user_agent_filter,
+          policy: policy
         )
       end
 

data/lib/ngrokapi/models/ip_policy.rb

@@ -13,8 +13,7 @@ module NgrokAPI
         :uri,
         :created_at,
         :description,
-        :metadata,
-        :action
+        :metadata
 
       def initialize(client: nil, attrs: {})
         @client = client
@@ -26,7 +25,6 @@ module NgrokAPI
         @created_at = @attrs['created_at']
         @description = @attrs['description']
         @metadata = @attrs['metadata']
-        @action = @attrs['action']
       end
 
       def ==(other)

data/lib/ngrokapi/models/reserved_addr.rb

@@ -15,8 +15,7 @@ module NgrokAPI
         :description,
         :metadata,
         :addr,
-        :region,
-        :endpoint_configuration
+        :region
 
       def initialize(client: nil, attrs: {})
         @client = client
@@ -30,7 +29,6 @@ module NgrokAPI
         @metadata = @attrs['metadata']
         @addr = @attrs['addr']
         @region = @attrs['region']
-        @endpoint_configuration = @attrs['endpoint_configuration']
       end
 
       def ==(other)

data/lib/ngrokapi/models/reserved_domain.rb

@@ -17,8 +17,6 @@ module NgrokAPI
         :domain,
         :region,
         :cname_target,
-        :http_endpoint_configuration,
-        :https_endpoint_configuration,
         :certificate,
         :certificate_management_policy,
         :certificate_management_status,
@@ -37,8 +35,6 @@ module NgrokAPI
         @domain = @attrs['domain']
         @region = @attrs['region']
         @cname_target = @attrs['cname_target']
-        @http_endpoint_configuration = @attrs['http_endpoint_configuration']
-        @https_endpoint_configuration = @attrs['https_endpoint_configuration']
         @certificate = @attrs['certificate']
         @certificate_management_policy = @attrs['certificate_management_policy']
         @certificate_management_status = @attrs['certificate_management_status']

data/lib/ngrokapi/models/static_backend.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'uri'
+
+module NgrokAPI
+  module Models
+    class StaticBackend
+      attr_reader :client,
+        :attrs,
+        :id,
+        :uri,
+        :created_at,
+        :description,
+        :metadata,
+        :address,
+        :tls
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @id = @attrs['id']
+        unless @attrs['uri'].nil?
+          @uri = URI(@attrs['uri'])
+        end
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @address = @attrs['address']
+        @tls = @attrs['tls']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+
+      ##
+      # Delete a static backend by ID.
+      #
+      # https://ngrok.com/docs/api#api-static-backends-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update static backend by ID
+      #
+      # https://ngrok.com/docs/api#api-static-backends-update
+      def update(
+        description: nil,
+        metadata: nil,
+        address: "",
+        tls: nil
+      )
+        @description = description if description
+        @metadata = metadata if metadata
+        @address = address if address
+        @tls = tls if tls
+        @client.update(
+          id: @id,
+          description: description,
+          metadata: metadata,
+          address: address,
+          tls: tls
+        )
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/static_backend_tls.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Models
+    class StaticBackendTLS
+      attr_reader :client,
+        :attrs,
+        :enabled
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @enabled = @attrs['enabled']
+      end
+
+      def ==(other)
+        @attrs == other.attrs
+      end
+
+      def to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
+      end
+    end
+  end
+end

data/lib/ngrokapi/models/tcp_edge.rb

@@ -16,7 +16,8 @@ module NgrokAPI
         :uri,
         :hostports,
         :backend,
-        :ip_restriction
+        :ip_restriction,
+        :policy
 
       def initialize(client: nil, attrs: {})
         @client = client
@@ -31,6 +32,7 @@ module NgrokAPI
         @hostports = @attrs['hostports']
         @backend = @attrs['backend']
         @ip_restriction = @attrs['ip_restriction']
+        @policy = @attrs['policy']
       end
 
       def ==(other)
@@ -57,20 +59,23 @@ module NgrokAPI
         metadata: nil,
         hostports: nil,
         backend: nil,
-        ip_restriction: nil
+        ip_restriction: nil,
+        policy: nil
       )
         @description = description if description
         @metadata = metadata if metadata
         @hostports = hostports if hostports
         @backend = backend if backend
         @ip_restriction = ip_restriction if ip_restriction
+        @policy = policy if policy
         @client.update(
           id: @id,
           description: description,
           metadata: metadata,
           hostports: hostports,
           backend: backend,
-          ip_restriction: ip_restriction
+          ip_restriction: ip_restriction,
+          policy: policy
         )
       end
 

data/lib/ngrokapi/models/tls_edge.rb

@@ -18,7 +18,8 @@ module NgrokAPI
         :backend,
         :ip_restriction,
         :mutual_tls,
-        :tls_termination
+        :tls_termination,
+        :policy
 
       def initialize(client: nil, attrs: {})
         @client = client
@@ -35,6 +36,7 @@ module NgrokAPI
         @ip_restriction = @attrs['ip_restriction']
         @mutual_tls = @attrs['mutual_tls']
         @tls_termination = @attrs['tls_termination']
+        @policy = @attrs['policy']
       end
 
       def ==(other)
@@ -63,7 +65,8 @@ module NgrokAPI
         backend: nil,
         ip_restriction: nil,
         mutual_tls: nil,
-        tls_termination: nil
+        tls_termination: nil,
+        policy: nil
       )
         @description = description if description
         @metadata = metadata if metadata
@@ -72,6 +75,7 @@ module NgrokAPI
         @ip_restriction = ip_restriction if ip_restriction
         @mutual_tls = mutual_tls if mutual_tls
         @tls_termination = tls_termination if tls_termination
+        @policy = policy if policy
         @client.update(
           id: @id,
           description: description,
@@ -80,7 +84,8 @@ module NgrokAPI
           backend: backend,
           ip_restriction: ip_restriction,
           mutual_tls: mutual_tls,
-          tls_termination: tls_termination
+          tls_termination: tls_termination,
+          policy: policy
         )
       end