ngrok-api 0.25.0 → 0.26.0

data/lib/ngrokapi/services/ip_policies_client.rb

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

@@ -147,7 +147,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-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,
@@ -173,7 +177,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-policy-rules-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/ip_restrictions_client.rb

@@ -151,7 +151,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-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,
@@ -177,7 +181,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-ip-restrictions-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/reserved_addrs_client.rb

@@ -140,7 +140,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-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,
@@ -166,7 +170,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-addrs-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/reserved_domains_client.rb

@@ -153,7 +153,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-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,
@@ -179,7 +183,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-reserved-domains-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/secrets_client.rb

@@ -198,7 +198,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-secrets-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,
@@ -224,7 +228,11 @@ module NgrokAPI
       # @return [NgrokAPI::Models::Listable] result from the API request
       #
       # https://ngrok.com/docs/api#api-secrets-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_certificate_authorities_client.rb

@@ -147,7 +147,11 @@ module NgrokAPI
       # @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,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -173,7 +177,11 @@ module NgrokAPI
       # @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,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

data/lib/ngrokapi/services/ssh_credentials_client.rb

@@ -149,7 +149,11 @@ module NgrokAPI
       # @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,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -175,7 +179,11 @@ module NgrokAPI
       # @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,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

data/lib/ngrokapi/services/ssh_host_certificates_client.rb

@@ -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

@@ -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

@@ -146,7 +146,11 @@ module NgrokAPI
       # @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,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -172,7 +176,11 @@ module NgrokAPI
       # @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,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

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

@@ -31,7 +31,11 @@ module NgrokAPI
       # @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,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -57,7 +61,11 @@ module NgrokAPI
       # @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,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

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,6 +177,81 @@ 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
       #
@@ -186,7 +261,11 @@ module NgrokAPI
       # @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,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,
@@ -212,7 +291,11 @@ module NgrokAPI
       # @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,
+        url: nil
+      )
         result = @client.list(
           before_id: before_id,
           limit: limit,

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.26.0".freeze
   # rubocop:enable Layout/SpaceAroundOperators
 end

data/spec/ngrokapi/services/vaults_client_spec.rb

@@ -174,6 +174,21 @@ RSpec.describe NgrokAPI::Services::VaultsClient do
     end
   end
 
+  describe "#get_secrets_by_vault" do
+    it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
+      path = '/vaults/%{id}/secrets'
+      replacements = {
+        id: vaults_get_secrets_by_vault_input["id"],
+      }
+      path = path % replacements
+      expect(@client).to receive(:list).
+        and_return(secret_results)
+      url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
+      result = @vaults_client.get_secrets_by_vault(url: url)
+      expect(result.class).to eq(NgrokAPI::Models::Listable)
+    end
+  end
+
   describe "#list" do
     it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
       expect(@client).to receive(:list).

data/spec/spec_helper.rb

@@ -1655,3 +1655,9 @@ def vault_results
     "next_page_uri" => nil,
   }
 end
+
+def vaults_get_secrets_by_vault_input
+  {
+    "id" => vault_result["id"],
+  }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngrok-api
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - ''