ngrok-api 0.22.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aa2e37daa52ab6c8caa28ef92531a668796f40da01645bdacca95de71f00e85
-  data.tar.gz: 71e3967190fc44f23824da53e409651cbeb0c773acbda7140aa898ee99a2d4a7
+  metadata.gz: c486ad586effb6b26fb928d459b8bbc03dde0517545f8f0c33f6cbd6542e373f
+  data.tar.gz: 3e033d87b0ac91187ccd5f2fc2c859c5307d362ef8dd8073e7dc53ab0731124b
 SHA512:
-  metadata.gz: fdb31d1ab2181acf0b8e243f5c7d728fae9e0527546551fcc1aa63498aeafe54d0a173bb21e53a53bae46bae498dd861a99343fa8a6e5bc53bfd687e7b82e255
-  data.tar.gz: 52477399d98274d22ea3cf5fcaf51132a134f6d331e86e9e4a4a5c5e849ab1ece92d8aa92b6d3010bbfede8c98887040c110ebc6f63a033d7be19d94a2d595fa
+  metadata.gz: 3044b91ebf8678f0d2b18b82d14a3db9a33d8695c3a232c71047d0c1c03075c3c5667b0add55ca98ec7aebd2d2ad394087f52e68b0bb15bc5fa9276e0ab5fd4c
+  data.tar.gz: 79ce1f61464edad0015792671a0e3fad0e29b349e071995cec9365fbafac3861c2815e451fd032fe5bd30c78865afffcae5087dd2d285c77ec6c0ac77f0fa477

data/.gitignore

@@ -1,6 +1,5 @@
 # Code generated for API Clients. DO NOT EDIT.
 
-Gemfile.lock
 .DS_Store
 .yardoc/
 tmp/

data/CHANGELOG.md

@@ -1,9 +1,17 @@
 <!-- Code generated for API Clients. DO NOT EDIT. -->
 
-## 0.16.0
+## 0.24.0
+* Added support for Cloud Endpoints (currently in private beta).
+
+## 0.23.0
+* Renamed the Policy Module to the Traffic Policy Module on HTTP Edge Routes, TCP Edges, and TLS Edges, which allows you to configure rules that can be used to influence and control traffic to and from your upstream service. The Traffic Policy itself is now specified as either a JSON or YAML string.
+
+## 0.22.0
 
 * Added support for the Bot User API. The Bot User API allows you to manage the bots that are registered to your ngrok account. You can automate the creation, management, and deletion of bot users in your account.
 
+* Added support for the Policy Module on HTTP Edge Routes, TCP Edges, and TLS Edges, which allows you to configure rules that can be used to influence and control traffic to and from your upstream service.
+
 ## 0.15.0
 
 ENHANCEMENTS:

data/Gemfile

@@ -3,33 +3,33 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'rake'
+gem 'rake', '~> 13.2.1'
 
 group :development do
   # https://github.com/guard/guard
-  gem 'guard'
+  gem 'guard', '~> 2.18.1'
   # https://github.com/guard/guard-rspec
-  gem 'guard-rspec'
+  gem 'guard-rspec', '~> 4.7.3'
   # https://github.com/guard/guard-bundler
-  gem 'guard-bundler'
+  gem 'guard-bundler', '~> 3.0.1'
 end
 
 group :test do
   # https://github.com/rspec/rspec
-  gem 'rspec'
+  gem 'rspec', '~> 3.13.0'
   # https://github.com/simplecov-ruby/simplecov
-  gem 'simplecov', require: false
+  gem 'simplecov', '~> 0.22.0', require: false
   # https://github.com/bblimke/webmock
-  gem 'webmock'
+  gem 'webmock', '~> 3.23.1'
 end
 
 group :development, :test do
   # https://github.com/pry/pry
-  gem 'pry'
+  gem 'pry', '~> 0.14.2'
   # https://github.com/lsegal/yard
-  gem 'yard'
+  gem 'yard', '~> 0.9.36'
   # https://github.com/airbnb/ruby/tree/master/rubocop
-  gem 'rubocop'
+  gem 'rubocop', '~> 1.32.0'
   # https://github.com/airbnb/ruby/tree/master/rubocop-airbnb
-  gem 'rubocop-airbnb'
+  gem 'rubocop-airbnb', '~> 6.0.0'
 end

data/Gemfile.lock

@@ -0,0 +1,175 @@
+PATH
+  remote: .
+  specs:
+    ngrok-api (0.24.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    drb (2.2.1)
+    ffi (1.17.0)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86_64-darwin)
+    formatador (1.1.0)
+    guard (2.18.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (3.0.1)
+      bundler (>= 2.1, < 3)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.1.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.10)
+    method_source (1.1.0)
+    minitest (5.24.1)
+    mutex_m (0.2.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (3.1.7)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    regexp_parser (2.9.2)
+    rexml (3.3.4)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.32.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-airbnb (6.0.0)
+      rubocop (~> 1.32.0)
+      rubocop-performance (~> 1.10.2)
+      rubocop-rails (~> 2.9.1)
+      rubocop-rspec (~> 2.0.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.10.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rspec (2.0.1)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.13.0)
+    shellany (0.0.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    strscan (3.1.0)
+    thor (1.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.36)
+
+PLATFORMS
+  aarch64-linux
+  aarch64-linux-musl
+  arm-linux
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux
+  x86_64-linux-musl
+
+DEPENDENCIES
+  guard (~> 2.18.1)
+  guard-bundler (~> 3.0.1)
+  guard-rspec (~> 4.7.3)
+  ngrok-api!
+  pry (~> 0.14.2)
+  rake (~> 13.2.1)
+  rspec (~> 3.13.0)
+  rubocop (~> 1.32.0)
+  rubocop-airbnb (~> 6.0.0)
+  simplecov (~> 0.22.0)
+  webmock (~> 3.23.1)
+  yard (~> 0.9.36)
+
+BUNDLED WITH
+   2.5.9

data/README.md

@@ -92,3 +92,24 @@ bundle exec rubocop 'lib'
 # Run rubcop on all files
 bundle exec rubocop
 ```
+
+## Building (internal)
+
+This is intended for ngrok employees who are updating this client library.
+
+On a standard Ubuntu machine, you will need these packages to get gems to build/install properly:
+
+```bash
+sudo apt install gcc make ruby-dev
+```
+
+Then to actually install:
+
+```bash
+gem install bundler --user-install
+
+# may need to change the ruby version here if yours is different
+~/.local/share/gem/ruby/3.0.0/bin/bundle install --path "$HOME/.local/share/gem"
+```
+
+This will update the Gemfile.lock as a side-effect.

data/doc/NgrokAPI/Client.html

@@ -845,7 +845,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Abuse Reports allow you to submit take-down requests for URLs hosted by  ngrok that violate ngrok’s terms of service.</p>
+<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok’s terms of service.</p>
 
 
   </div>
@@ -929,7 +929,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself  to provision and manage API Keys but you’ll need to provision your first API  key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your  ngrok.com dashboard.</p>
+<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself to provision and manage API Keys but you’ll need to provision your first API key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your ngrok.com dashboard.</p>
 
 
   </div>
@@ -1117,7 +1117,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Certificate Authorities are x509 certificates that are used to sign other  x509 certificates. Attach a Certificate Authority to the Mutual TLS module  to verify that the TLS certificate presented by a client has been signed by  this CA. Certificate Authorities are used only for mTLS validation only and  thus a private key is not included in the resource.</p>
+<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.</p>
 
 
   </div>
@@ -1171,7 +1171,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok  agent to connect the ngrok service as your account. They are installed with  the <code>ngrok config add-authtoken</code> command or by specifying it in the <code>ngrok.yml</code>  configuration file with the <code>authtoken</code> property.</p>
+<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok config add-authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p>
 
 
   </div>
@@ -1252,7 +1252,10 @@
 263
 264
 265
-266</pre>
+266
+267
+268
+269</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 242</span>
@@ -1273,12 +1276,15 @@
   <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_oidc'>https_edge_route_oidc</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EdgeRouteOIDCModuleClient.html" title="NgrokAPI::Services::EdgeRouteOIDCModuleClient (class)">EdgeRouteOIDCModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteOIDCModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteOIDCModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_websocket_tcp_converter'>https_edge_route_websocket_tcp_converter</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EdgeRouteWebsocketTCPConverterModuleClient.html" title="NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient (class)">EdgeRouteWebsocketTCPConverterModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteWebsocketTCPConverterModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_user_agent_filter'>https_edge_route_user_agent_filter</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EdgeRouteUserAgentFilterModuleClient.html" title="NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient (class)">EdgeRouteUserAgentFilterModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteUserAgentFilterModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_traffic_policy'>https_edge_route_traffic_policy</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EdgeRouteTrafficPolicyModuleClient.html" title="NgrokAPI::Services::EdgeRouteTrafficPolicyModuleClient (class)">EdgeRouteTrafficPolicyModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteTrafficPolicyModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteTrafficPolicyModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tcp_edge_backend'>tcp_edge_backend</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TCPEdgeBackendModuleClient.html" title="NgrokAPI::Services::TCPEdgeBackendModuleClient (class)">TCPEdgeBackendModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TCPEdgeBackendModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TCPEdgeBackendModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tcp_edge_ip_restriction'>tcp_edge_ip_restriction</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TCPEdgeIPRestrictionModuleClient.html" title="NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient (class)">TCPEdgeIPRestrictionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TCPEdgeIPRestrictionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tcp_edge_traffic_policy'>tcp_edge_traffic_policy</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TCPEdgeTrafficPolicyModuleClient.html" title="NgrokAPI::Services::TCPEdgeTrafficPolicyModuleClient (class)">TCPEdgeTrafficPolicyModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TCPEdgeTrafficPolicyModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TCPEdgeTrafficPolicyModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tls_edge_backend'>tls_edge_backend</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSEdgeBackendModuleClient.html" title="NgrokAPI::Services::TLSEdgeBackendModuleClient (class)">TLSEdgeBackendModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSEdgeBackendModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSEdgeBackendModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tls_edge_ip_restriction'>tls_edge_ip_restriction</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSEdgeIPRestrictionModuleClient.html" title="NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient (class)">TLSEdgeIPRestrictionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSEdgeIPRestrictionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tls_edge_mutual_tls'>tls_edge_mutual_tls</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSEdgeMutualTLSModuleClient.html" title="NgrokAPI::Services::TLSEdgeMutualTLSModuleClient (class)">TLSEdgeMutualTLSModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSEdgeMutualTLSModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSEdgeMutualTLSModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tls_edge_tls_termination'>tls_edge_tls_termination</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSEdgeTLSTerminationModuleClient.html" title="NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient (class)">TLSEdgeTLSTerminationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSEdgeTLSTerminationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tls_edge_traffic_policy'>tls_edge_traffic_policy</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSEdgeTrafficPolicyModuleClient.html" title="NgrokAPI::Services::TLSEdgeTrafficPolicyModuleClient (class)">TLSEdgeTrafficPolicyModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSEdgeTrafficPolicyModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSEdgeTrafficPolicyModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
 
   <span class='id identifier rubyid_ns'>ns</span>
 <span class='kw'>end</span></pre>
@@ -1341,7 +1347,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Endpoints provides an API for querying the endpoint objects  which define what tunnel or edge is used to serve a hostport.  Only active endpoints associated with a tunnel or backend are returned.</p>
+<p>Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.</p>
 
 
   </div>
@@ -1485,7 +1491,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code>  action. They can be attached to endpoints via the Endpoint Configuration IP  Policy module. They can also be used with IP Restrictions to control source  IP ranges that can start tunnel sessions and connect to the API and dashboard.</p>
+<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.</p>
 
 
   </div>
@@ -1539,7 +1545,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that  make up an IP Policy.</p>
+<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
 
 
   </div>
@@ -1593,7 +1599,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>An IP restriction is a restriction placed on the CIDRs that are allowed to  initiate traffic to a specific aspect of your ngrok account. An IP  restriction has a type which defines the ingress it applies to. IP  restrictions can be used to enforce the source IPs that can make API  requests, log in to the dashboard, start ngrok agents, and connect to your  public-facing endpoints.</p>
+<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initiate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.</p>
 
 
   </div>
@@ -1647,7 +1653,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Reserved Addresses are TCP addresses that can be used to listen for traffic.  TCP address hostnames and ports are assigned by ngrok, they cannot be  chosen.</p>
+<p>Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.</p>
 
 
   </div>
@@ -1701,7 +1707,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Reserved Domains are hostnames that you can listen for traffic on. Domains  can be used to listen for http, https or tls traffic. You may use a domain  that you own by creating a CNAME record specified in the returned resource.  This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
+<p>Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
 
 
   </div>
@@ -1755,7 +1761,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>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.</p>
+<p>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.</p>
 
 
   </div>
@@ -1809,7 +1815,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels  via the ngrok SSH tunnel gateway.</p>
+<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
 
 
   </div>
@@ -1863,7 +1869,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>SSH Host Certificates along with the corresponding private key allows an SSH  server to assert its authenticity to connecting SSH clients who trust the  SSH Certificate Authority that was used to sign the certificate.</p>
+<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p>
 
 
   </div>
@@ -1917,7 +1923,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>SSH User Certificates are presented by SSH clients when connecting to an SSH  server to authenticate their connection. The SSH server must trust the SSH  Certificate Authority used to sign the certificate.</p>
+<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.</p>
 
 
   </div>
@@ -1971,7 +1977,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>TLS Certificates are pairs of x509 certificates and their matching private  key that can be used to terminate TLS traffic. TLS certificates are unused  until they are attached to a Domain. TLS Certificates may also be  provisioned by ngrok automatically for domains on which you have enabled  automated certificate provisioning.</p>
+<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.</p>
 
 
   </div>
@@ -2025,7 +2031,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel  sessions that are running and connected to the ngrok service. Each tunnel  session can include one or more Tunnels.</p>
+<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.</p>
 
 
   </div>
@@ -2079,7 +2085,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Tunnels provide endpoints to access services exposed by a running ngrok  agent tunnel session or an SSH reverse tunnel session.</p>
+<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
 
 
   </div>
@@ -2126,9 +2132,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:13 2024 by
+  Generated on Thu Oct 24 20:57:22 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/NgrokAPI/Error.html

@@ -295,9 +295,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:13 2024 by
+  Generated on Thu Oct 24 20:57:22 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/NgrokAPI/Errors/NotFoundError.html

@@ -299,9 +299,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:15 2024 by
+  Generated on Thu Oct 24 20:57:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/NgrokAPI/Errors.html

@@ -105,9 +105,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:13 2024 by
+  Generated on Thu Oct 24 20:57:22 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/NgrokAPI/HttpClient.html

@@ -1267,9 +1267,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:13 2024 by
+  Generated on Thu Oct 24 20:57:22 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/NgrokAPI/Models/APIKey.html

@@ -1189,9 +1189,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:13 2024 by
+  Generated on Thu Oct 24 20:57:23 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/NgrokAPI/Models/AWSAuth.html

@@ -659,9 +659,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:13 2024 by
+  Generated on Thu Oct 24 20:57:23 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/NgrokAPI/Models/AWSCredentials.html

@@ -659,9 +659,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:15 2024 by
+  Generated on Thu Oct 24 20:57:24 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/NgrokAPI/Models/AWSRole.html

@@ -585,9 +585,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:13 2024 by
+  Generated on Thu Oct 24 20:57:23 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/NgrokAPI/Models/AbuseReport.html

@@ -1033,9 +1033,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:14 2024 by
+  Generated on Thu Oct 24 20:57:23 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>

data/doc/NgrokAPI/Models/AbuseReportHostname.html

@@ -659,9 +659,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Apr 30 20:26:19 2024 by
+  Generated on Thu Oct 24 20:57:27 2024 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.36 (ruby-3.3.0).
+  0.9.36 (ruby-3.3.5).
 </div>
 
     </div>