ngrok-api 0.18.0 → 0.21.0

data/lib/ngrokapi/services/tunnel_group_backends_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -37,11 +39,33 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:labels] = labels if labels
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new TunnelGroup backend
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, string>] labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+      # @return [NgrokAPI::Models::TunnelGroupBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-tunnel-group-backends-create
+      def create!(description: "", metadata: "", labels: {})
+        path = '/backends/tunnel_group'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:labels] = labels if labels
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
       end
 
       ##
-      # Delete a TunnelGroup backend by ID. TODO what if used?
+      # Delete a TunnelGroup backend by ID.
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
@@ -56,7 +80,7 @@ module NgrokAPI
       end
 
       ##
-      # Delete a TunnelGroup backend by ID. TODO what if used?
+      # Delete a TunnelGroup backend by ID.
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier
@@ -85,7 +109,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
       end
 
       ##
@@ -103,7 +127,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
       end
 
       ##
@@ -115,8 +139,7 @@ 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,
@@ -126,7 +149,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::TunnelGroupBackend
         )
@@ -142,8 +165,7 @@ 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,
@@ -154,7 +176,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::TunnelGroupBackend,
           danger: true
@@ -181,7 +203,7 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:labels] = labels if labels
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
       end
 
       ##
@@ -205,7 +227,7 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:labels] = labels if labels
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::TunnelGroupBackend.new(client: self, result: result)
+        NgrokAPI::Models::TunnelGroupBackend.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/services/tunnel_sessions_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -29,8 +31,7 @@ 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,
@@ -40,7 +41,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::TunnelSession
         )
@@ -56,8 +57,7 @@ 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,
@@ -68,7 +68,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::TunnelSession,
           danger: true
@@ -89,7 +89,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::TunnelSession.new(client: self, result: result)
+        NgrokAPI::Models::TunnelSession.new(client: self, attrs: result)
       end
 
       ##
@@ -107,7 +107,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::TunnelSession.new(client: self, result: result)
+        NgrokAPI::Models::TunnelSession.new(client: self, attrs: result)
       end
 
       ##

data/lib/ngrokapi/services/tunnels_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -28,8 +30,7 @@ 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,
@@ -39,7 +40,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::Tunnel
         )
@@ -55,8 +56,7 @@ 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,
@@ -67,7 +67,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::Tunnel,
           danger: true
@@ -88,7 +88,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::Tunnel.new(client: self, result: result)
+        NgrokAPI::Models::Tunnel.new(client: self, attrs: result)
       end
 
       ##
@@ -106,7 +106,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::Tunnel.new(client: self, result: result)
+        NgrokAPI::Models::Tunnel.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/services/weighted_backends_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Code generated for API Clients. DO NOT EDIT.
+
 module NgrokAPI
   module Services
     ##
@@ -26,7 +28,7 @@ module NgrokAPI
       #
       # @param [string] description human-readable description of this backend. Optional
       # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
-      # @param [Map<string, int64>] backends the ids of the child backends to their weights (0-10000)
+      # @param [Map<string, int64>] backends the ids of the child backends to their weights [0-10000]
       # @return [NgrokAPI::Models::WeightedBackend] result from the API request
       #
       # https://ngrok.com/docs/api#api-weighted-backends-create
@@ -39,11 +41,33 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:backends] = backends if backends
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::WeightedBackend.new(client: self, result: result)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
+      end
+
+      ##
+      # Create a new Weighted backend
+      # Throws an exception if API error.
+      #
+      # @param [string] description human-readable description of this backend. Optional
+      # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
+      # @param [Map<string, int64>] backends the ids of the child backends to their weights [0-10000]
+      # @return [NgrokAPI::Models::WeightedBackend] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-weighted-backends-create
+      def create!(description: "", metadata: "", backends: {})
+        path = '/backends/weighted'
+        replacements = {
+        }
+        data = {}
+        data[:description] = description if description
+        data[:metadata] = metadata if metadata
+        data[:backends] = backends if backends
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
       end
 
       ##
-      # Delete a Weighted backend by ID. TODO what if used?
+      # Delete a Weighted backend by ID.
       #
       # @param [string] id a resource identifier
       # @return [NgrokAPI::Models::Empty] result from the API request
@@ -58,7 +82,7 @@ module NgrokAPI
       end
 
       ##
-      # Delete a Weighted backend by ID. TODO what if used?
+      # Delete a Weighted backend by ID.
       # Throws an exception if API error.
       #
       # @param [string] id a resource identifier
@@ -87,7 +111,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::WeightedBackend.new(client: self, result: result)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
       end
 
       ##
@@ -105,7 +129,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::WeightedBackend.new(client: self, result: result)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
       end
 
       ##
@@ -117,8 +141,7 @@ 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,
@@ -128,7 +151,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::WeightedBackend
         )
@@ -144,8 +167,7 @@ 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,
@@ -156,7 +178,7 @@ module NgrokAPI
 
         NgrokAPI::Models::Listable.new(
           client: self,
-          result: result,
+          attrs: result,
           list_property: LIST_PROPERTY,
           klass: NgrokAPI::Models::WeightedBackend,
           danger: true
@@ -169,7 +191,7 @@ module NgrokAPI
       # @param [string] id
       # @param [string] description human-readable description of this backend. Optional
       # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
-      # @param [Map<string, int64>] backends the ids of the child backends to their weights (0-10000)
+      # @param [Map<string, int64>] backends the ids of the child backends to their weights [0-10000]
       # @return [NgrokAPI::Models::WeightedBackend] result from the API request
       #
       # https://ngrok.com/docs/api#api-weighted-backends-update
@@ -183,7 +205,7 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:backends] = backends if backends
         result = @client.patch(path % replacements, data: data)
-        NgrokAPI::Models::WeightedBackend.new(client: self, result: result)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
       end
 
       ##
@@ -193,7 +215,7 @@ module NgrokAPI
       # @param [string] id
       # @param [string] description human-readable description of this backend. Optional
       # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
-      # @param [Map<string, int64>] backends the ids of the child backends to their weights (0-10000)
+      # @param [Map<string, int64>] backends the ids of the child backends to their weights [0-10000]
       # @return [NgrokAPI::Models::WeightedBackend] result from the API request
       #
       # https://ngrok.com/docs/api#api-weighted-backends-update
@@ -207,7 +229,7 @@ module NgrokAPI
         data[:metadata] = metadata if metadata
         data[:backends] = backends if backends
         result = @client.patch(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::WeightedBackend.new(client: self, result: result)
+        NgrokAPI::Models::WeightedBackend.new(client: self, attrs: result)
       end
     end
   end

data/lib/ngrokapi/version.rb

@@ -1,7 +1,9 @@
-module NgrokAPI
-  # rubocop:disable Layout/SpaceAroundOperators
-
-  # The current version of the gem
-  VERSION="0.18.0".freeze
-  # rubocop:enable Layout/SpaceAroundOperators
-end
+# Code generated for API Clients. DO NOT EDIT.
+
+module NgrokAPI
+  # rubocop:disable Layout/SpaceAroundOperators
+
+  # The current version of the gem
+  VERSION="0.21.0".freeze
+  # rubocop:enable Layout/SpaceAroundOperators
+end

data/lib/ngrokapi.rb

@@ -1,13 +1,15 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'net/http'
-
-Dir[File.join('.', 'lib', '**/*.rb')].sort.each do |f|
-  require f
-end
-
-##
-# The Module which contains the Ngrok API gem
-module NgrokAPI
-end
+# frozen_string_literal: true
+
+# Code generated for API Clients. DO NOT EDIT.
+
+require 'json'
+require 'net/http'
+
+Dir[File.join(__dir__, '**', '*.rb')].sort.each do |f|
+  require f
+end
+
+##
+# The Module which contains the Ngrok API gem
+module NgrokAPI
+end

data/ngrok-api.gemspec

@@ -1,27 +1,29 @@
-# -*- encoding: utf-8 -*-
-
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
-require 'ngrokapi/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'ngrok-api'
-  s.version     = NgrokAPI::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.licenses    = ['MIT']
-  s.authors     = ['']
-  s.email       = ['']
-  s.homepage    = 'https://github.com/ngrok/ngrok-api-ruby'
-  s.summary     = 'This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
-    it easier to consume in Ruby.'
-  s.description = 'This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
-    it easier to consume in Ruby.'
-
-  s.required_ruby_version = '>= 2.7.2'
-
-  all_files = `git ls-files`.split("\n")
-  test_files = `git ls-files -- {test,spec,features}/*`.split('\n')
-
-  s.files = all_files - test_files
-  s.executables = `git ls-files -- bin/*`.split('\n').map { |f| File.basename(f) }
-  s.require_paths = ['lib']
-end
+# -*- encoding: utf-8 -*-
+
+# Code generated for API Clients. DO NOT EDIT.
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'ngrokapi/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ngrok-api'
+  s.version     = NgrokAPI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+  s.authors     = ['']
+  s.email       = ['']
+  s.homepage    = 'https://github.com/ngrok/ngrok-api-ruby'
+  s.summary     = 'This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
+    it easier to consume in Ruby.'
+  s.description = 'This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
+    it easier to consume in Ruby.'
+
+  s.required_ruby_version = '>= 2.7.2'
+
+  all_files = `git ls-files`.split("\n")
+  test_files = `git ls-files -- {test,spec,features}/*`.split('\n')
+
+  s.files = all_files - test_files
+  s.executables = `git ls-files -- bin/*`.split('\n').map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/spec/ngrokapi/client_spec.rb

@@ -1,3 +1,5 @@
+# Code generated for API Clients. DO NOT EDIT.
+
 require 'spec_helper'
 require 'ostruct'
 
@@ -24,6 +26,24 @@ RSpec.describe NgrokAPI::Client do
     end
   end
 
+  describe "#application_sessions" do
+    it "returns an instance of the ApplicationSessionsClient" do
+      expect(@client.application_sessions.class).to eq(NgrokAPI::Services::ApplicationSessionsClient)
+    end
+  end
+
+  describe "#application_users" do
+    it "returns an instance of the ApplicationUsersClient" do
+      expect(@client.application_users.class).to eq(NgrokAPI::Services::ApplicationUsersClient)
+    end
+  end
+
+  describe "#tunnel_sessions" do
+    it "returns an instance of the TunnelSessionsClient" do
+      expect(@client.tunnel_sessions.class).to eq(NgrokAPI::Services::TunnelSessionsClient)
+    end
+  end
+
   describe "#certificate_authorities" do
     it "returns an instance of the CertificateAuthoritiesClient" do
       expect(@client.certificate_authorities.class).to eq(NgrokAPI::Services::CertificateAuthoritiesClient)
@@ -120,12 +140,6 @@ RSpec.describe NgrokAPI::Client do
     end
   end
 
-  describe "#tunnel_sessions" do
-    it "returns an instance of the TunnelSessionsClient" do
-      expect(@client.tunnel_sessions.class).to eq(NgrokAPI::Services::TunnelSessionsClient)
-    end
-  end
-
   describe "#tunnels" do
     it "returns an instance of the TunnelsClient" do
       expect(@client.tunnels.class).to eq(NgrokAPI::Services::TunnelsClient)