ngrok-api 0.25.0 → 0.27.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
@@ -143,14 +143,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-ssh-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
         )
@@ -169,14 +176,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-ssh-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/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 = {
         }
@@ -145,14 +145,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-ssh-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
         )
@@ -171,14 +178,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-ssh-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/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
@@ -156,7 +156,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-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,
@@ -182,7 +186,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-host-certificates-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/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
@@ -164,7 +164,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-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,
@@ -190,7 +194,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ssh-user-certificates-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/static_backends_client.rb

@@ -143,7 +143,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-static-backends-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,
@@ -169,7 +173,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-static-backends-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/tls_certificates_client.rb

@@ -142,14 +142,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-tls-certificates-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
         )
@@ -168,14 +175,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-tls-certificates-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/tunnel_group_backends_client.rb

@@ -139,7 +139,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-group-backends-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,
@@ -165,7 +169,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnel-group-backends-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/tunnel_sessions_client.rb

@@ -27,14 +27,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-tunnel-sessions-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
         )
@@ -53,14 +60,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-tunnel-sessions-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/tunnels_client.rb

@@ -30,7 +30,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnels-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,
@@ -56,7 +60,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-tunnels-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/vaults_client.rb

@@ -177,19 +177,101 @@ module NgrokAPI
         NgrokAPI::Models::Vault.new(client: self, attrs: result)
       end
 
+      ##
+      # Get Secrets by Vault ID
+      #
+      # @param [string] id a resource identifier
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-vaults-get-secrets-by-vault
+      def get_secrets_by_vault(
+        id: "",
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
+        path = '/vaults/%{id}/secrets'
+        replacements = {
+          id: id,
+        }
+        result = @client.list(
+          id: id,
+          before_id: before_id,
+          limit: limit,
+          url: url,
+          path: path % replacements
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          attrs: result,
+          list_property: 'secrets',
+          klass: NgrokAPI::Models::Secret
+        )
+      end
+
+      ##
+      # Get Secrets by Vault ID
+      # Throws an exception if API error.
+      #
+      # @param [string] id a resource identifier
+      # @param [string] before_id
+      # @param [string] limit
+      # @param [string] url optional and mutually exclusive from before_id and limit
+      # @return [NgrokAPI::Models::Listable] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-vaults-get-secrets-by-vault
+      def get_secrets_by_vault!(
+        id: "",
+        before_id: nil,
+        limit: nil,
+        url: nil
+      )
+        path = '/vaults/%{id}/secrets'
+        replacements = {
+          id: id,
+        }
+        result = @client.list(
+          id: id,
+          before_id: before_id,
+          limit: limit,
+          danger: true,
+          url: url,
+          path: path % replacements
+        )
+
+        NgrokAPI::Models::Listable.new(
+          client: self,
+          attrs: result,
+          list_property: 'secrets',
+          klass: NgrokAPI::Models::Secret,
+          danger: true
+        )
+      end
+
       ##
       # List all Vaults owned by account
       #
       # @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-vaults-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
         )
@@ -208,14 +290,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-vaults-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/weighted_backends_client.rb

@@ -141,7 +141,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-weighted-backends-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,
@@ -167,7 +171,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-weighted-backends-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/version.rb

@@ -4,6 +4,6 @@ module NgrokAPI
   # rubocop:disable Layout/SpaceAroundOperators
 
   # The current version of the gem
-  VERSION="0.25.0".freeze
+  VERSION="0.27.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/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/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"])