ngrok-api 0.25.0 → 0.27.0

data/docs/top-level-namespace.html

@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 14 22:44:14 2025 by
+  Generated on Tue Dec 16 19:21:52 2025 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/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

@@ -138,14 +138,21 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @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-agent-ingresses-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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,14 +171,21 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @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-agent-ingresses-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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

@@ -140,14 +140,21 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @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-api-keys-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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,14 +173,21 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @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-api-keys-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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/application_sessions_client.rb

@@ -93,7 +93,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-application-sessions-list
-      def list(before_id: nil, limit: nil, url: nil)
+      def list(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -119,7 +123,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-application-sessions-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      def list!(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

data/lib/ngrokapi/services/application_users_client.rb

@@ -93,7 +93,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-application-users-list
-      def list(before_id: nil, limit: nil, url: nil)
+      def list(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -119,7 +123,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-application-users-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      def list!(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

data/lib/ngrokapi/services/bot_users_client.rb

@@ -132,7 +132,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-bot-users-list
-      def list(before_id: nil, limit: nil, url: nil)
+      def list(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -158,7 +162,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-bot-users-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      def list!(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

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
@@ -138,14 +138,21 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @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-certificate-authorities-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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,14 +171,21 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @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-certificate-authorities-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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

@@ -36,7 +36,7 @@ module NgrokAPI
       # @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 = {
         }
@@ -63,7 +63,7 @@ module NgrokAPI
       # @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 = {
         }
@@ -147,14 +147,21 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @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-credentials-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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
         )
@@ -173,14 +180,21 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @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-credentials-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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/edges_https_client.rb

@@ -113,7 +113,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-edges-https-list
-      def list(before_id: nil, limit: nil, url: nil)
+      def list(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -139,7 +143,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-edges-https-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      def list!(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

data/lib/ngrokapi/services/edges_tcp_client.rb

@@ -117,7 +117,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-edges-tcp-list
-      def list(before_id: nil, limit: nil, url: nil)
+      def list(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -143,7 +147,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-edges-tcp-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      def list!(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

data/lib/ngrokapi/services/edges_tls_client.rb

@@ -125,7 +125,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-edges-tls-list
-      def list(before_id: nil, limit: nil, url: nil)
+      def list(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -151,7 +155,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-edges-tls-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      def list!(
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

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 = {
         }
@@ -86,18 +86,25 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
-      # @param [List<string>] ids
-      # @param [List<string>] urls
+      # @param [List<string>] id
+      # @param [List<string>] url
+      # @param [string] filter
       # @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-endpoints-list
-      def list(before_id: nil, limit: nil, ids: [], urls: [], url: nil)
+      def list(
+        before_id: nil,
+        limit: nil,
+        id: [],
+        filter: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
-          ids: ids,
-          urls: urls,
+          id: id,
+          filter: filter,
           url: url,
           path: PATH
         )
@@ -116,18 +123,25 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
-      # @param [List<string>] ids
-      # @param [List<string>] urls
+      # @param [List<string>] id
+      # @param [List<string>] url
+      # @param [string] filter
       # @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-endpoints-list
-      def list!(before_id: nil, limit: nil, ids: [], urls: [], url: nil)
+      def list!(
+        before_id: nil,
+        limit: nil,
+        id: [],
+        filter: nil,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
-          ids: ids,
-          urls: urls,
+          id: id,
+          filter: filter,
           danger: true,
           url: url,
           path: PATH
@@ -190,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,
@@ -220,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

@@ -140,14 +140,21 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @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-destinations-list
-      def list(before_id: nil, limit: nil, url: nil)
+      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,14 +173,21 @@ module NgrokAPI
       #
       # @param [string] before_id
       # @param [string] limit
+      # @param [string] filter
       # @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-destinations-list
-      def list!(before_id: nil, limit: nil, url: nil)
+      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