ngrok-api 0.26.0 → 0.28.0

data/docs/top-level-namespace.html

@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Aug 19 22:49:31 2025 by
+  Generated on Fri Jan 23 21:38:00 2026 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.8).
+  0.9.36 (ruby-3.3.10).
 </div>
 
     </div>

data/lib/ngrokapi/client.rb

@@ -168,6 +168,10 @@ module NgrokAPI
       @_secrets ||= NgrokAPI::Services::SecretsClient.new(client: @client)
     end
 
+    def service_users
+      @_service_users ||= NgrokAPI::Services::ServiceUsersClient.new(client: @client)
+    end
+
     ##
     # An SSH Certificate Authority is a pair of an SSH Certificate and its private
     #  key that can be used to sign other SSH host and user certificates.

data/lib/ngrokapi/models/endpoint.rb

@@ -95,7 +95,7 @@ module NgrokAPI
         description: nil,
         metadata: nil,
         bindings: nil,
-        pooling_enabled: False
+        pooling_enabled: nil
       )
         @url = url if url
         @traffic_policy = traffic_policy if traffic_policy

data/lib/ngrokapi/models/reserved_domain.rb

@@ -20,7 +20,8 @@ module NgrokAPI
         :certificate,
         :certificate_management_policy,
         :certificate_management_status,
-        :acme_challenge_cname_target
+        :acme_challenge_cname_target,
+        :resolves_to
 
       def initialize(client: nil, attrs: {})
         @client = client
@@ -39,6 +40,7 @@ module NgrokAPI
         @certificate_management_policy = @attrs['certificate_management_policy']
         @certificate_management_status = @attrs['certificate_management_status']
         @acme_challenge_cname_target = @attrs['acme_challenge_cname_target']
+        @resolves_to = @attrs['resolves_to']
       end
 
       def ==(other)

data/lib/ngrokapi/models/reserved_domain_resolves_to_entry.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  module Models
+    class ReservedDomainResolvesToEntry
+      attr_reader :client,
+        :attrs,
+        :value
+
+      def initialize(client: nil, attrs: {})
+        @client = client
+        @attrs = attrs
+        @value = @attrs['value']
+      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/secret.rb

@@ -18,7 +18,8 @@ module NgrokAPI
         :metadata,
         :created_by,
         :last_updated_by,
-        :vault
+        :vault,
+        :vault_name
 
       def initialize(client: nil, attrs: {})
         @client = client
@@ -35,6 +36,7 @@ module NgrokAPI
         @created_by = @attrs['created_by']
         @last_updated_by = @attrs['last_updated_by']
         @vault = @attrs['vault']
+        @vault_name = @attrs['vault_name']
       end
 
       def ==(other)

data/lib/ngrokapi/models/service_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 ServiceUser
+      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 service user by ID
+      #
+      # https://ngrok.com/docs/api#api-service-users-delete
+      def delete
+        @client.delete(
+          id: @id
+        )
+      end
+
+      ##
+      # Update attributes of a service user by ID.
+      #
+      # https://ngrok.com/docs/api#api-service-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/services/agent_ingresses_client.rb

@@ -136,8 +136,9 @@ module NgrokAPI
       ##
       # List all Agent Ingresses owned by this account
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -145,11 +146,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -166,8 +169,9 @@ module NgrokAPI
       # List all Agent Ingresses owned by this account
       # Throws an exception if API error.
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -175,11 +179,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/api_keys_client.rb

@@ -138,8 +138,9 @@ module NgrokAPI
       ##
       # List all API keys owned by this account
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -147,11 +148,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -168,8 +171,9 @@ module NgrokAPI
       # List all API keys owned by this account
       # Throws an exception if API error.
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -177,11 +181,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/certificate_authorities_client.rb

@@ -99,7 +99,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about a certficate authority
+      # Get detailed information about a certificate authority
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::CertificateAuthority] result from the API request
@@ -116,7 +116,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about a certficate authority
+      # Get detailed information about a certificate authority
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier
@@ -136,8 +136,9 @@ module NgrokAPI
       ##
       # List all Certificate Authority on this account
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -145,11 +146,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -166,8 +169,9 @@ module NgrokAPI
       # List all Certificate Authority on this account
       # Throws an exception if API error.
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -175,11 +179,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/credentials_client.rb

@@ -32,11 +32,11 @@ module NgrokAPI
       # @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
       # @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
       # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
-      # @param [string] owner_id If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
+      # @param [string] owner_id If supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID.
       # @return [NgrokAPI::Models::Credential] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-create
-      def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil)
+      def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil, scim_user_id: "")
         path = '/credentials'
         replacements = {
         }
@@ -59,11 +59,11 @@ module NgrokAPI
       # @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
       # @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
       # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
-      # @param [string] owner_id If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
+      # @param [string] owner_id If supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID.
       # @return [NgrokAPI::Models::Credential] result from the API request
       #
       # https://ngrok.com/docs/api#api-credentials-create
-      def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil)
+      def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil, scim_user_id: "")
         path = '/credentials'
         replacements = {
         }
@@ -145,8 +145,9 @@ module NgrokAPI
       ##
       # List all tunnel authtoken credentials on this account
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -154,11 +155,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -175,8 +178,9 @@ module NgrokAPI
       # List all tunnel authtoken credentials on this account
       # Throws an exception if API error.
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -184,11 +188,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/endpoints_client.rb

@@ -35,7 +35,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Endpoint] result from the API request
       #
       # https://ngrok.com/docs/api#api-endpoints-create
-      def create(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
+      def create(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil)
         path = '/endpoints'
         replacements = {
         }
@@ -65,7 +65,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Endpoint] result from the API request
       #
       # https://ngrok.com/docs/api#api-endpoints-create
-      def create!(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
+      def create!(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil)
         path = '/endpoints'
         replacements = {
         }
@@ -84,10 +84,11 @@ module NgrokAPI
       ##
       # List all active endpoints on the account
       #
-      # @param [string] before_id
-      # @param [string] limit
-      # @param [List<string>] id
-      # @param [List<string>] url
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [List<string>] id Filter results by endpoint IDs. Deprecated: use ``filter`` instead.
+      # @param [List<string>] url Filter results by endpoint URLs. Deprecated: use ``filter`` instead.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -96,12 +97,14 @@ module NgrokAPI
         before_id: nil,
         limit: nil,
         id: [],
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
           id: id,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -118,10 +121,11 @@ module NgrokAPI
       # List all active endpoints on the account
       # Throws an exception if API error.
       #
-      # @param [string] before_id
-      # @param [string] limit
-      # @param [List<string>] id
-      # @param [List<string>] url
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [List<string>] id Filter results by endpoint IDs. Deprecated: use ``filter`` instead.
+      # @param [List<string>] url Filter results by endpoint URLs. Deprecated: use ``filter`` instead.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -130,12 +134,14 @@ module NgrokAPI
         before_id: nil,
         limit: nil,
         id: [],
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
           id: id,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH
@@ -198,7 +204,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Endpoint] result from the API request
       #
       # https://ngrok.com/docs/api#api-endpoints-update
-      def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
+      def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil)
         path = '/endpoints/%{id}'
         replacements = {
           id: id,
@@ -228,7 +234,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Endpoint] result from the API request
       #
       # https://ngrok.com/docs/api#api-endpoints-update
-      def update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
+      def update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil)
         path = '/endpoints/%{id}'
         replacements = {
           id: id,

data/lib/ngrokapi/services/event_destinations_client.rb

@@ -138,8 +138,9 @@ module NgrokAPI
       ##
       # List all Event Destinations on this account.
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -147,11 +148,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -168,8 +171,9 @@ module NgrokAPI
       # List all Event Destinations on this account.
       # Throws an exception if API error.
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -177,11 +181,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH

data/lib/ngrokapi/services/event_subscriptions_client.rb

@@ -134,8 +134,9 @@ module NgrokAPI
       ##
       # List this Account's Event Subscriptions.
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -143,11 +144,13 @@ module NgrokAPI
       def list(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -164,8 +167,9 @@ module NgrokAPI
       # List this Account's Event Subscriptions.
       # Throws an exception if API error.
       #
-      # @param [string] before_id
-      # @param [string] limit
+      # @param [string] before_id Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
+      # @param [string] limit Constrains the number of results in the dataset. See the `API Overview <https://ngrok.com/docs/api/index#pagination>`_ for details.
+      # @param [string] filter A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as ``id``, ``metadata``, ``created_at``, and more. See ngrok API Filtering for syntax and field details: `https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>`_.
       # @param [string] url optional and mutually exclusive from before_id and limit
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
@@ -173,11 +177,13 @@ module NgrokAPI
       def list!(
         before_id: nil,
         limit: nil,
+        filter: nil,
         url: nil
       )
         result = @client.list(
           before_id: before_id,
           limit: limit,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH