ngrok-api 0.26.0 → 0.28.0

data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb

@@ -104,7 +104,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH Certficate Authority
+      # Get detailed information about an SSH Certificate Authority
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::SSHCertificateAuthority] result from the API request
@@ -121,7 +121,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH Certficate Authority
+      # Get detailed information about an SSH Certificate Authority
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier
@@ -141,8 +141,9 @@ module NgrokAPI
       ##
       # List all SSH Certificate Authorities 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
       #
@@ -150,11 +151,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
         )
@@ -171,8 +174,9 @@ module NgrokAPI
       # List all SSH Certificate Authorities 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
       #
@@ -180,11 +184,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/ssh_credentials_client.rb

@@ -33,7 +33,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCredential] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-create
-      def create(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "")
+      def create(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "", scim_user_id: "")
         path = '/ssh_credentials'
         replacements = {
         }
@@ -60,7 +60,7 @@ module NgrokAPI
       # @return [NgrokAPI::Models::SSHCredential] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-credentials-create
-      def create!(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "")
+      def create!(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "", scim_user_id: "")
         path = '/ssh_credentials'
         replacements = {
         }
@@ -143,8 +143,9 @@ module NgrokAPI
       ##
       # List all ssh 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
       #
@@ -152,11 +153,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
         )
@@ -173,8 +176,9 @@ module NgrokAPI
       # List all ssh 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
       #
@@ -182,11 +186,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/ssh_host_certificates_client.rb

@@ -113,7 +113,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH Host Certficate
+      # Get detailed information about an SSH Host Certificate
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::SSHHostCertificate] result from the API request
@@ -130,7 +130,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH Host Certficate
+      # Get detailed information about an SSH Host Certificate
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier

data/lib/ngrokapi/services/ssh_user_certificates_client.rb

@@ -121,7 +121,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH User Certficate
+      # Get detailed information about an SSH User Certificate
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::SSHUserCertificate] result from the API request
@@ -138,7 +138,7 @@ module NgrokAPI
       end
 
       ##
-      # Get detailed information about an SSH User Certficate
+      # Get detailed information about an SSH User Certificate
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier

data/lib/ngrokapi/services/tls_certificates_client.rb

@@ -140,8 +140,9 @@ module NgrokAPI
       ##
       # List all TLS certificates 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
       #
@@ -149,11 +150,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
         )
@@ -170,8 +173,9 @@ module NgrokAPI
       # List all TLS certificates 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
       #
@@ -179,11 +183,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/tunnel_sessions_client.rb

@@ -25,8 +25,9 @@ module NgrokAPI
       ##
       # List all online tunnel sessions running 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
       #
@@ -34,11 +35,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
         )
@@ -55,8 +58,9 @@ module NgrokAPI
       # List all online tunnel sessions running 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
       #
@@ -64,11 +68,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/vaults_client.rb

@@ -255,8 +255,9 @@ module NgrokAPI
       ##
       # List all Vaults owned by 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
       #
@@ -264,11 +265,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
         )
@@ -285,8 +288,9 @@ module NgrokAPI
       # List all Vaults owned by 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
       #
@@ -294,11 +298,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/version.rb

@@ -4,6 +4,6 @@ module NgrokAPI
   # rubocop:disable Layout/SpaceAroundOperators
 
   # The current version of the gem
-  VERSION="0.26.0".freeze
+  VERSION="0.28.0".freeze
   # rubocop:enable Layout/SpaceAroundOperators
 end

data/spec/ngrokapi/client_spec.rb

@@ -122,6 +122,12 @@ RSpec.describe NgrokAPI::Client do
     end
   end
 
+  describe "#service_users" do
+    it "returns an instance of the ServiceUsersClient" do
+      expect(@client.service_users.class).to eq(NgrokAPI::Services::ServiceUsersClient)
+    end
+  end
+
   describe "#ssh_certificate_authorities" do
     it "returns an instance of the SSHCertificateAuthoritiesClient" do
       expect(@client.ssh_certificate_authorities.class).to eq(NgrokAPI::Services::SSHCertificateAuthoritiesClient)

data/spec/ngrokapi/models/reserved_domain_resolves_to_entry_spec.rb

@@ -0,0 +1,23 @@
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Models::ReservedDomainResolvesToEntry do
+  before(:each) do
+    @client = class_double("ReservedDomainResolvesToEntrysClient")
+    @reserved_domain_resolves_to_entry = NgrokAPI::Models::ReservedDomainResolvesToEntry.new(client: @client, attrs: reserved_domain_resolves_to_entry_result)
+  end
+
+  describe "#==" do
+    it "is equal if the results are the same" do
+      other = NgrokAPI::Models::ReservedDomainResolvesToEntry.new(client: @client, attrs: reserved_domain_resolves_to_entry_result)
+      expect(@reserved_domain_resolves_to_entry == other).to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "stringifies as result.to_s" do
+      expect(@reserved_domain_resolves_to_entry.to_s).to eq reserved_domain_resolves_to_entry_result.to_s
+    end
+  end
+end

data/spec/ngrokapi/models/service_user_spec.rb

@@ -0,0 +1,44 @@
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'spec_helper'
+
+RSpec.describe NgrokAPI::Models::ServiceUser do
+  before(:each) do
+    @client = class_double("ServiceUsersClient")
+    @service_user = NgrokAPI::Models::ServiceUser.new(client: @client, attrs: service_user_result)
+  end
+
+  describe "#==" do
+    it "is equal if the results are the same" do
+      other = NgrokAPI::Models::ServiceUser.new(client: @client, attrs: service_user_result)
+      expect(@service_user == other).to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "stringifies as result.to_s" do
+      expect(@service_user.to_s).to eq service_user_result.to_s
+    end
+  end
+
+  describe "#delete" do
+    it "calls delete on the client" do
+      expect(@service_user.client).to receive(:delete)
+      @service_user.delete
+    end
+  end
+
+  describe "#update" do
+    it "calls update on the client" do
+      new_name = 'New name'
+      new_active = 'New active'
+      expect(@service_user.client).to receive(:update)
+      @service_user.update(
+        name: new_name,
+        active: new_active
+      )
+      expect(@service_user.name).to eq new_name
+      expect(@service_user.active).to eq new_active
+    end
+  end
+end

data/spec/ngrokapi/services/credentials_client_spec.rb

@@ -32,7 +32,8 @@ RSpec.describe NgrokAPI::Services::CredentialsClient do
         acl: "New acl",
         owner_id: "New owner_id",
         owner_email: "New owner_email",
-        precomputed_token: "New precomputed_token"
+        precomputed_token: "New precomputed_token",
+        scim_user_id: "New scim_user_id"
       )
       expect(result.class).to eq(NgrokAPI::Models::Credential)
     end
@@ -56,7 +57,8 @@ RSpec.describe NgrokAPI::Services::CredentialsClient do
         acl: "New acl",
         owner_id: "New owner_id",
         owner_email: "New owner_email",
-        precomputed_token: "New precomputed_token"
+        precomputed_token: "New precomputed_token",
+        scim_user_id: "New scim_user_id"
       )
       expect(result.class).to eq(NgrokAPI::Models::Credential)
       # expect(result.id).to eq(credential_result["id"])

data/spec/ngrokapi/services/reserved_domains_client_spec.rb

@@ -26,6 +26,7 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do
       data[:metadata] = "New metadata"
       data[:certificate_id] = "New certificate_id"
       data[:certificate_management_policy] = "New certificate_management_policy"
+      data[:resolves_to] = "New resolves_to"
       expect(@client).to receive(:post).with(path % replacements, data: data).
         and_return(reserved_domain_result)
       result = @reserved_domains_client.create(
@@ -38,7 +39,8 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do
         https_endpoint_configuration_id: "New https_endpoint_configuration_id",
         certificate_id: "New certificate_id",
         certificate_management_policy: "New certificate_management_policy",
-        error_redirect_url: "New error_redirect_url"
+        error_redirect_url: "New error_redirect_url",
+        resolves_to: "New resolves_to"
       )
       expect(result.class).to eq(NgrokAPI::Models::ReservedDomain)
     end
@@ -56,6 +58,7 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do
       data[:metadata] = "New metadata"
       data[:certificate_id] = "New certificate_id"
       data[:certificate_management_policy] = "New certificate_management_policy"
+      data[:resolves_to] = "New resolves_to"
       expect(@client).to receive(:post).with(path % replacements, data: data).
         and_return(reserved_domain_result)
       result = @reserved_domains_client.create(
@@ -68,7 +71,8 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do
         https_endpoint_configuration_id: "New https_endpoint_configuration_id",
         certificate_id: "New certificate_id",
         certificate_management_policy: "New certificate_management_policy",
-        error_redirect_url: "New error_redirect_url"
+        error_redirect_url: "New error_redirect_url",
+        resolves_to: "New resolves_to"
       )
       expect(result.class).to eq(NgrokAPI::Models::ReservedDomain)
       # expect(result.id).to eq(reserved_domain_result["id"])
@@ -170,6 +174,7 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do
       data[:metadata] = "New metadata"
       data[:certificate_id] = "New certificate_id"
       data[:certificate_management_policy] = "New certificate_management_policy"
+      data[:resolves_to] = "New resolves_to"
       expect(@client).to receive(:patch).with(path % replacements, data: data).
         and_return(reserved_domain_result)
       result = @reserved_domains_client.update(
@@ -181,7 +186,8 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do
         certificate_id: "New certificate_id",
         certificate_management_policy: "New certificate_management_policy",
         region: "New region",
-        error_redirect_url: "New error_redirect_url"
+        error_redirect_url: "New error_redirect_url",
+        resolves_to: "New resolves_to"
       )
       expect(result.class).to eq(NgrokAPI::Models::ReservedDomain)
     end
@@ -198,6 +204,7 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do
       data[:metadata] = "New metadata"
       data[:certificate_id] = "New certificate_id"
       data[:certificate_management_policy] = "New certificate_management_policy"
+      data[:resolves_to] = "New resolves_to"
       expect(@client).to receive(:patch).with(path % replacements, data: data).
         and_return(reserved_domain_result)
       result = @reserved_domains_client.update(
@@ -209,7 +216,8 @@ RSpec.describe NgrokAPI::Services::ReservedDomainsClient do
         certificate_id: "New certificate_id",
         certificate_management_policy: "New certificate_management_policy",
         region: "New region",
-        error_redirect_url: "New error_redirect_url"
+        error_redirect_url: "New error_redirect_url",
+        resolves_to: "New resolves_to"
       )
       expect(result.class).to eq(NgrokAPI::Models::ReservedDomain)
       # expect(result.id).to eq(reserved_domain_result["id"])

data/spec/ngrokapi/services/secrets_client_spec.rb

@@ -25,6 +25,7 @@ RSpec.describe NgrokAPI::Services::SecretsClient do
       data[:metadata] = "New metadata"
       data[:description] = "New description"
       data[:vault_id] = "New vault_id"
+      data[:vault_name] = "New vault_name"
       expect(@client).to receive(:post).with(path % replacements, data: data).
         and_return(secret_result)
       result = @secrets_client.create(
@@ -32,7 +33,8 @@ RSpec.describe NgrokAPI::Services::SecretsClient do
         value: "New value",
         metadata: "New metadata",
         description: "New description",
-        vault_id: "New vault_id"
+        vault_id: "New vault_id",
+        vault_name: "New vault_name"
       )
       expect(result.class).to eq(NgrokAPI::Models::Secret)
     end
@@ -49,6 +51,7 @@ RSpec.describe NgrokAPI::Services::SecretsClient do
       data[:metadata] = "New metadata"
       data[:description] = "New description"
       data[:vault_id] = "New vault_id"
+      data[:vault_name] = "New vault_name"
       expect(@client).to receive(:post).with(path % replacements, data: data).
         and_return(secret_result)
       result = @secrets_client.create(
@@ -56,7 +59,8 @@ RSpec.describe NgrokAPI::Services::SecretsClient do
         value: "New value",
         metadata: "New metadata",
         description: "New description",
-        vault_id: "New vault_id"
+        vault_id: "New vault_id",
+        vault_name: "New vault_name"
       )
       expect(result.class).to eq(NgrokAPI::Models::Secret)
       # expect(result.id).to eq(secret_result["id"])