Low-level api client for communicating with Ngrok's HTTP API using HTTP. You should not have to use this class directly, but use the individual clients to make your API calls.
Update this endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.
Iterate through the result set, returning the next instance if we already have one, or make a new API call to next_page_uri to get more results and return the next one from that call.
# File 'lib/ngrokapi/paged_iterator.rb', line 8
+
+defclient
+ @client
+end
+
+
+
+
+
+
+
+
+
+
+ #list_property ⇒ Object(readonly)
+
+
+
+
+
+
+
+
+
Returns the value of attribute list_property.
+
+
+
+
+
+
+
+
+
+
+
+
+
+8
+9
+10
+
+
+
# File 'lib/ngrokapi/paged_iterator.rb', line 8
+
+deflist_property
+ @list_property
+end
+
+
+
+
+
+
+
+
+
+
+ #n ⇒ Object
+
+
+
+
+
+
+
+
+
Returns the value of attribute n.
+
+
+
+
+
+
+
+
+
+
+
+
+
+7
+8
+9
+
+
+
# File 'lib/ngrokapi/paged_iterator.rb', line 7
+
+defn
+ @n
+end
+
+
+
+
+
+
+
+
+
+
+ #page ⇒ Object
+
+
+
+
+
+
+
+
+
Returns the value of attribute page.
+
+
+
+
+
+
+
+
+
+
+
+
+
+7
+8
+9
+
+
+
# File 'lib/ngrokapi/paged_iterator.rb', line 7
+
+defpage
+ @page
+end
+
+
+
+
+
+
+
+
+
+
Instance Method Details
+
+
+
+
+
+ #get_next ⇒ object
+
+
+
+
+
+
+
+
+
Iterate through the result set, returning the next instance if we already have one, or make a new API call to next_page_uri to get more results and return the next one from that call.
Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.
+
+ id
+
+
+ (string)
+
+
+ (defaults to: nil)
+
+
+ —
+
+
a resource identifier
+
+
+
+
+
+
+
Returns:
+
+
+
+
+
+ (nil)
+
+
+
+ —
+
+
result from delete request
+
+
+
+
+
+
+
+
+
+
+
+
+92
+93
+94
+
+
+
# File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 92
+
+defdelete(id:nil)
+ @client.delete("#{PATH}/#{id}")
+end
+
+
+
+
+
+
+
+
+ #delete!(id: nil) ⇒ nil
+
+
+
+
+
+
+
+
+
Delete an endpoint configuration. Throw an exception if 404. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.
Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throw an exception if 404.
+
+ name
+
+
+ (string)
+
+
+ (defaults to: '')
+
+
+ —
+
+
the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
+
+
+
+
+
+
+ region
+
+
+ (string)
+
+
+ (defaults to: '')
+
+
+ —
+
+
reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.
ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.
ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with “certificate_management_policy“.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with “certificate_id“.
Please consult the documentation for additional examples.
+
+
require'ngrokapi/client'
+client=NgrokAPI::Client.new(api_key:'<API KEY>')
+
+# Get an instance of the api_keys client and list all API keys
+keys_client=client.api_keys
+keys_client.list
+
+
+
Local Documentation
+
+
Documentation can be generated with the command:
+
+
bundleexecyarddoc'lib/**/*.rb'
+
+
+
This will generate documentation which can be viewed within the doc folder.
+
+
Specs
+
+
Specs can be run with the command:
+
+
bundleexecrake
+
+
+
This will generate a coverage report which can be viewed within the coverage folder.
+
+
Rubocop
+
+
Rubocop can be run with the command:
+
+
# Run rubocop on lib folder
+bundleexecrubocop'lib'
+
+# Run rubcop on all files
+bundleexecrubocop
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/file_list.html b/docs/file_list.html
new file mode 100644
index 0000000..2b6df40
--- /dev/null
+++ b/docs/file_list.html
@@ -0,0 +1,56 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ File List
+
+
+
+
Please consult the documentation for additional examples.
+
+
require'ngrokapi/client'
+client=NgrokAPI::Client.new(api_key:'<API KEY>')
+
+# Get an instance of the api_keys client and list all API keys
+keys_client=client.api_keys
+keys_client.list
+
+
+
Local Documentation
+
+
Documentation can be generated with the command:
+
+
bundleexecyarddoc'lib/**/*.rb'
+
+
+
This will generate documentation which can be viewed within the doc folder.
+
+
Specs
+
+
Specs can be run with the command:
+
+
bundleexecrake
+
+
+
This will generate a coverage report which can be viewed within the coverage folder.
+
+
Rubocop
+
+
Rubocop can be run with the command:
+
+
# Run rubocop on lib folder
+bundleexecrubocop'lib'
+
+# Run rubcop on all files
+bundleexecrubocop
+