ngrok-api 0.12.0 → 0.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +184 -182
- data/doc/NgrokAPI/Error.html +1 -1
- data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/doc/NgrokAPI/Errors.html +1 -1
- data/doc/NgrokAPI/HttpClient.html +55 -19
- data/doc/NgrokAPI/Models/APIKey.html +1 -1
- data/doc/NgrokAPI/Models/AWSAuth.html +1 -1
- data/doc/NgrokAPI/Models/AWSCredentials.html +1 -1
- data/doc/NgrokAPI/Models/AWSRole.html +1 -1
- data/doc/NgrokAPI/Models/AbuseReport.html +1 -1
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +1 -1
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1 -1
- data/doc/NgrokAPI/Models/Credential.html +1 -1
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +1 -1
- data/doc/NgrokAPI/Models/EndpointCompression.html +1 -1
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1 -1
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +1 -1
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointLogging.html +1 -1
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +1 -1
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuth.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1 -1
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +1 -1
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +1 -1
- data/doc/NgrokAPI/Models/EndpointSAML.html +1 -1
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +1 -1
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +1 -1
- data/doc/NgrokAPI/Models/EventDestination.html +1 -1
- data/doc/NgrokAPI/Models/EventSource.html +1 -1
- data/doc/NgrokAPI/Models/{ReservedDomainCertNSTarget.html → EventSourceList.html} +42 -42
- data/doc/NgrokAPI/Models/EventSourceReplace.html +1 -1
- data/doc/NgrokAPI/Models/EventStream.html +1 -1
- data/doc/NgrokAPI/Models/EventSubscription.html +1 -1
- data/doc/NgrokAPI/Models/EventTarget.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +1 -1
- data/doc/NgrokAPI/Models/IPPolicy.html +1 -1
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1 -1
- data/doc/NgrokAPI/Models/IPRestriction.html +1 -1
- data/doc/NgrokAPI/Models/IPWhitelistEntry.html +1 -1
- data/doc/NgrokAPI/Models/Listable.html +118 -50
- data/doc/NgrokAPI/Models/Ref.html +1 -1
- data/doc/NgrokAPI/Models/ReservedAddr.html +1 -1
- data/doc/NgrokAPI/Models/ReservedDomain.html +91 -17
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +12 -86
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +1 -1
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +1 -1
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1 -1
- data/doc/NgrokAPI/Models/SSHCredential.html +1 -1
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1 -1
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1 -1
- data/doc/NgrokAPI/Models/TLSCertificate.html +1 -1
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +1 -1
- data/doc/NgrokAPI/Models/Tunnel.html +1 -1
- data/doc/NgrokAPI/Models/TunnelSession.html +1 -1
- data/doc/NgrokAPI/Models.html +3 -3
- data/doc/NgrokAPI/PagedIterator.html +14 -10
- data/doc/NgrokAPI/Services/APIKeysClient.html +227 -62
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -5
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +206 -41
- data/doc/NgrokAPI/Services/CredentialsClient.html +213 -47
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +281 -114
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +221 -50
- data/doc/NgrokAPI/Services/EventSourcesClient.html +279 -33
- data/doc/NgrokAPI/Services/EventStreamsClient.html +218 -47
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +213 -42
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +207 -41
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +210 -42
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +215 -51
- data/doc/NgrokAPI/Services/IPWhitelistClient.html +206 -38
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +230 -63
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +308 -142
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +208 -40
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +213 -45
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +207 -40
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +209 -42
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +208 -43
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +260 -93
- data/doc/NgrokAPI/Services/TunnelsClient.html +174 -6
- data/doc/NgrokAPI/Services.html +1 -1
- data/doc/NgrokAPI.html +2 -2
- data/doc/README +94 -0
- data/doc/_index.html +8 -8
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +53 -26
- data/doc/index.html +53 -26
- data/doc/method_list.html +822 -630
- data/doc/top-level-namespace.html +1 -1
- data/docs/NgrokAPI/Client.html +184 -182
- data/docs/NgrokAPI/Error.html +1 -1
- data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/docs/NgrokAPI/Errors.html +1 -1
- data/docs/NgrokAPI/HttpClient.html +55 -19
- data/docs/NgrokAPI/Models/APIKey.html +1 -1
- data/docs/NgrokAPI/Models/AWSAuth.html +1 -1
- data/docs/NgrokAPI/Models/AWSCredentials.html +1 -1
- data/docs/NgrokAPI/Models/AWSRole.html +1 -1
- data/docs/NgrokAPI/Models/AbuseReport.html +1 -1
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +1 -1
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1 -1
- data/docs/NgrokAPI/Models/Credential.html +1 -1
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +1 -1
- data/docs/NgrokAPI/Models/EndpointCompression.html +1 -1
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1 -1
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +1 -1
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointLogging.html +1 -1
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +1 -1
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuth.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1 -1
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +1 -1
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +1 -1
- data/docs/NgrokAPI/Models/EndpointSAML.html +1 -1
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +1 -1
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +1 -1
- data/docs/NgrokAPI/Models/EventDestination.html +1 -1
- data/docs/NgrokAPI/Models/EventSource.html +1 -1
- data/docs/NgrokAPI/Models/{ReservedDomainCertNSTarget.html → EventSourceList.html} +42 -42
- data/docs/NgrokAPI/Models/EventSourceReplace.html +1 -1
- data/docs/NgrokAPI/Models/EventStream.html +1 -1
- data/docs/NgrokAPI/Models/EventSubscription.html +1 -1
- data/docs/NgrokAPI/Models/EventTarget.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +1 -1
- data/docs/NgrokAPI/Models/IPPolicy.html +1 -1
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1 -1
- data/docs/NgrokAPI/Models/IPRestriction.html +1 -1
- data/docs/NgrokAPI/Models/IPWhitelistEntry.html +1 -1
- data/docs/NgrokAPI/Models/Listable.html +118 -50
- data/docs/NgrokAPI/Models/Ref.html +1 -1
- data/docs/NgrokAPI/Models/ReservedAddr.html +1 -1
- data/docs/NgrokAPI/Models/ReservedDomain.html +91 -17
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +12 -86
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +1 -1
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +1 -1
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1 -1
- data/docs/NgrokAPI/Models/SSHCredential.html +1 -1
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1 -1
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1 -1
- data/docs/NgrokAPI/Models/TLSCertificate.html +1 -1
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +1 -1
- data/docs/NgrokAPI/Models/Tunnel.html +1 -1
- data/docs/NgrokAPI/Models/TunnelSession.html +1 -1
- data/docs/NgrokAPI/Models.html +3 -3
- data/docs/NgrokAPI/PagedIterator.html +14 -10
- data/docs/NgrokAPI/Services/APIKeysClient.html +227 -62
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -5
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +206 -41
- data/docs/NgrokAPI/Services/CredentialsClient.html +213 -47
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +281 -114
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +221 -50
- data/docs/NgrokAPI/Services/EventSourcesClient.html +279 -33
- data/docs/NgrokAPI/Services/EventStreamsClient.html +218 -47
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +213 -42
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +207 -41
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +210 -42
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +215 -51
- data/docs/NgrokAPI/Services/IPWhitelistClient.html +206 -38
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +230 -63
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +308 -142
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +208 -40
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +213 -45
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +207 -40
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +209 -42
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +208 -43
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +260 -93
- data/docs/NgrokAPI/Services/TunnelsClient.html +174 -6
- data/docs/NgrokAPI/Services.html +1 -1
- data/docs/NgrokAPI.html +2 -2
- data/docs/README +94 -0
- data/docs/_index.html +8 -8
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +53 -26
- data/docs/index.html +53 -26
- data/docs/method_list.html +822 -630
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/client.rb +27 -8
- data/lib/ngrokapi/http_client.rb +5 -3
- data/lib/ngrokapi/models/{reserved_domain_cert_ns_target.rb → event_source_list.rb} +5 -5
- data/lib/ngrokapi/models/listable.rb +13 -2
- data/lib/ngrokapi/models/reserved_domain.rb +3 -1
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +1 -3
- data/lib/ngrokapi/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/api_keys_client.rb +36 -4
- data/lib/ngrokapi/services/certificate_authorities_client.rb +33 -0
- data/lib/ngrokapi/services/credentials_client.rb +35 -2
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +33 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +33 -0
- data/lib/ngrokapi/services/event_sources_client.rb +39 -0
- data/lib/ngrokapi/services/event_streams_client.rb +33 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +33 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +34 -1
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +33 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +33 -0
- data/lib/ngrokapi/services/ip_whitelist_client.rb +34 -1
- data/lib/ngrokapi/services/reserved_addrs_client.rb +33 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +33 -0
- data/lib/ngrokapi/services/tunnels_client.rb +33 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +19 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +2 -2
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +0 -2
- data/spec/ngrokapi/services/api_keys_client_spec.rb +0 -3
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +0 -3
- data/spec/ngrokapi/services/credentials_client_spec.rb +0 -3
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -3
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +0 -3
- data/spec/ngrokapi/services/event_sources_client_spec.rb +33 -3
- data/spec/ngrokapi/services/event_streams_client_spec.rb +0 -3
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +0 -3
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -3
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +0 -1
- data/spec/spec_helper.rb +7 -0
- metadata +10 -7
- data/doc/.gitkeep +0 -0
- data/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +0 -21
@@ -329,6 +329,54 @@
|
|
329
329
|
<p>A new instance of EventSourcesClient.</p>
|
330
330
|
</div></span>
|
331
331
|
|
332
|
+
</li>
|
333
|
+
|
334
|
+
|
335
|
+
<li class="public ">
|
336
|
+
<span class="summary_signature">
|
337
|
+
|
338
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList </a>
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
</span>
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
<span class="summary_desc"><div class='inline'>
|
353
|
+
<p>List the types for which this event subscription will trigger.</p>
|
354
|
+
</div></span>
|
355
|
+
|
356
|
+
</li>
|
357
|
+
|
358
|
+
|
359
|
+
<li class="public ">
|
360
|
+
<span class="summary_signature">
|
361
|
+
|
362
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(subscription_id: "") ⇒ NgrokAPI::Models::EventSourceList </a>
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
</span>
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
<span class="summary_desc"><div class='inline'>
|
377
|
+
<p>List the types for which this event subscription will trigger Throws an exception if API error.</p>
|
378
|
+
</div></span>
|
379
|
+
|
332
380
|
</li>
|
333
381
|
|
334
382
|
|
@@ -1081,6 +1129,204 @@
|
|
1081
1129
|
</td>
|
1082
1130
|
</tr>
|
1083
1131
|
</table>
|
1132
|
+
</div>
|
1133
|
+
|
1134
|
+
<div class="method_details ">
|
1135
|
+
<h3 class="signature " id="list-instance_method">
|
1136
|
+
|
1137
|
+
#<strong>list</strong>(subscription_id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt>
|
1138
|
+
|
1139
|
+
|
1140
|
+
|
1141
|
+
|
1142
|
+
|
1143
|
+
</h3><div class="docstring">
|
1144
|
+
<div class="discussion">
|
1145
|
+
|
1146
|
+
<p>List the types for which this event subscription will trigger</p>
|
1147
|
+
|
1148
|
+
<p><a href="https://ngrok.com/docs/api#api-event-sources-list">ngrok.com/docs/api#api-event-sources-list</a></p>
|
1149
|
+
|
1150
|
+
|
1151
|
+
</div>
|
1152
|
+
</div>
|
1153
|
+
<div class="tags">
|
1154
|
+
<p class="tag_title">Parameters:</p>
|
1155
|
+
<ul class="param">
|
1156
|
+
|
1157
|
+
<li>
|
1158
|
+
|
1159
|
+
<span class='name'>subscription_id</span>
|
1160
|
+
|
1161
|
+
|
1162
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1163
|
+
|
1164
|
+
|
1165
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1166
|
+
|
1167
|
+
|
1168
|
+
—
|
1169
|
+
<div class='inline'>
|
1170
|
+
<p>The unique identifier for the Event Subscription that this Event Source is attached to.</p>
|
1171
|
+
</div>
|
1172
|
+
|
1173
|
+
</li>
|
1174
|
+
|
1175
|
+
</ul>
|
1176
|
+
|
1177
|
+
<p class="tag_title">Returns:</p>
|
1178
|
+
<ul class="return">
|
1179
|
+
|
1180
|
+
<li>
|
1181
|
+
|
1182
|
+
|
1183
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt>)</span>
|
1184
|
+
|
1185
|
+
|
1186
|
+
|
1187
|
+
—
|
1188
|
+
<div class='inline'>
|
1189
|
+
<p>result from the API request</p>
|
1190
|
+
</div>
|
1191
|
+
|
1192
|
+
</li>
|
1193
|
+
|
1194
|
+
</ul>
|
1195
|
+
|
1196
|
+
</div><table class="source_code">
|
1197
|
+
<tr>
|
1198
|
+
<td>
|
1199
|
+
<pre class="lines">
|
1200
|
+
|
1201
|
+
|
1202
|
+
134
|
1203
|
+
135
|
1204
|
+
136
|
1205
|
+
137
|
1206
|
+
138
|
1207
|
+
139
|
1208
|
+
140
|
1209
|
+
141
|
1210
|
+
142
|
1211
|
+
143
|
1212
|
+
144</pre>
|
1213
|
+
</td>
|
1214
|
+
<td>
|
1215
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 134</span>
|
1216
|
+
|
1217
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
1218
|
+
<span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
1219
|
+
<span class='rparen'>)</span>
|
1220
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_subscriptions/%{subscription_id}/sources</span><span class='tstring_end'>'</span></span>
|
1221
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1222
|
+
<span class='label'>subscription_id:</span> <span class='id identifier rubyid_subscription_id'>subscription_id</span><span class='comma'>,</span>
|
1223
|
+
<span class='rbrace'>}</span>
|
1224
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1225
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1226
|
+
<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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSourceList.html#initialize-instance_method" title="NgrokAPI::Models::EventSourceList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1227
|
+
<span class='kw'>end</span></pre>
|
1228
|
+
</td>
|
1229
|
+
</tr>
|
1230
|
+
</table>
|
1231
|
+
</div>
|
1232
|
+
|
1233
|
+
<div class="method_details ">
|
1234
|
+
<h3 class="signature " id="list!-instance_method">
|
1235
|
+
|
1236
|
+
#<strong>list!</strong>(subscription_id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt>
|
1237
|
+
|
1238
|
+
|
1239
|
+
|
1240
|
+
|
1241
|
+
|
1242
|
+
</h3><div class="docstring">
|
1243
|
+
<div class="discussion">
|
1244
|
+
|
1245
|
+
<p>List the types for which this event subscription will trigger Throws an exception if API error.</p>
|
1246
|
+
|
1247
|
+
<p><a href="https://ngrok.com/docs/api#api-event-sources-list">ngrok.com/docs/api#api-event-sources-list</a></p>
|
1248
|
+
|
1249
|
+
|
1250
|
+
</div>
|
1251
|
+
</div>
|
1252
|
+
<div class="tags">
|
1253
|
+
<p class="tag_title">Parameters:</p>
|
1254
|
+
<ul class="param">
|
1255
|
+
|
1256
|
+
<li>
|
1257
|
+
|
1258
|
+
<span class='name'>subscription_id</span>
|
1259
|
+
|
1260
|
+
|
1261
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1262
|
+
|
1263
|
+
|
1264
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1265
|
+
|
1266
|
+
|
1267
|
+
—
|
1268
|
+
<div class='inline'>
|
1269
|
+
<p>The unique identifier for the Event Subscription that this Event Source is attached to.</p>
|
1270
|
+
</div>
|
1271
|
+
|
1272
|
+
</li>
|
1273
|
+
|
1274
|
+
</ul>
|
1275
|
+
|
1276
|
+
<p class="tag_title">Returns:</p>
|
1277
|
+
<ul class="return">
|
1278
|
+
|
1279
|
+
<li>
|
1280
|
+
|
1281
|
+
|
1282
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">NgrokAPI::Models::EventSourceList</a></span></tt>)</span>
|
1283
|
+
|
1284
|
+
|
1285
|
+
|
1286
|
+
—
|
1287
|
+
<div class='inline'>
|
1288
|
+
<p>result from the API request</p>
|
1289
|
+
</div>
|
1290
|
+
|
1291
|
+
</li>
|
1292
|
+
|
1293
|
+
</ul>
|
1294
|
+
|
1295
|
+
</div><table class="source_code">
|
1296
|
+
<tr>
|
1297
|
+
<td>
|
1298
|
+
<pre class="lines">
|
1299
|
+
|
1300
|
+
|
1301
|
+
154
|
1302
|
+
155
|
1303
|
+
156
|
1304
|
+
157
|
1305
|
+
158
|
1306
|
+
159
|
1307
|
+
160
|
1308
|
+
161
|
1309
|
+
162
|
1310
|
+
163
|
1311
|
+
164</pre>
|
1312
|
+
</td>
|
1313
|
+
<td>
|
1314
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 154</span>
|
1315
|
+
|
1316
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
1317
|
+
<span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
1318
|
+
<span class='rparen'>)</span>
|
1319
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_subscriptions/%{subscription_id}/sources</span><span class='tstring_end'>'</span></span>
|
1320
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1321
|
+
<span class='label'>subscription_id:</span> <span class='id identifier rubyid_subscription_id'>subscription_id</span><span class='comma'>,</span>
|
1322
|
+
<span class='rbrace'>}</span>
|
1323
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1324
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
1325
|
+
<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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSourceList.html#initialize-instance_method" title="NgrokAPI::Models::EventSourceList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1326
|
+
<span class='kw'>end</span></pre>
|
1327
|
+
</td>
|
1328
|
+
</tr>
|
1329
|
+
</table>
|
1084
1330
|
</div>
|
1085
1331
|
|
1086
1332
|
<div class="method_details ">
|
@@ -1169,24 +1415,24 @@
|
|
1169
1415
|
<pre class="lines">
|
1170
1416
|
|
1171
1417
|
|
1172
|
-
|
1173
|
-
|
1174
|
-
|
1175
|
-
|
1176
|
-
|
1177
|
-
|
1178
|
-
|
1179
|
-
|
1180
|
-
|
1181
|
-
|
1182
|
-
|
1183
|
-
|
1184
|
-
|
1185
|
-
|
1186
|
-
|
1418
|
+
174
|
1419
|
+
175
|
1420
|
+
176
|
1421
|
+
177
|
1422
|
+
178
|
1423
|
+
179
|
1424
|
+
180
|
1425
|
+
181
|
1426
|
+
182
|
1427
|
+
183
|
1428
|
+
184
|
1429
|
+
185
|
1430
|
+
186
|
1431
|
+
187
|
1432
|
+
188</pre>
|
1187
1433
|
</td>
|
1188
1434
|
<td>
|
1189
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line
|
1435
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 174</span>
|
1190
1436
|
|
1191
1437
|
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
1192
1438
|
<span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
@@ -1294,24 +1540,24 @@
|
|
1294
1540
|
<pre class="lines">
|
1295
1541
|
|
1296
1542
|
|
1297
|
-
|
1298
|
-
|
1299
|
-
|
1300
|
-
|
1301
|
-
|
1302
|
-
|
1303
|
-
|
1304
|
-
|
1305
|
-
|
1306
|
-
|
1307
|
-
|
1308
|
-
|
1309
|
-
|
1310
|
-
|
1311
|
-
|
1543
|
+
199
|
1544
|
+
200
|
1545
|
+
201
|
1546
|
+
202
|
1547
|
+
203
|
1548
|
+
204
|
1549
|
+
205
|
1550
|
+
206
|
1551
|
+
207
|
1552
|
+
208
|
1553
|
+
209
|
1554
|
+
210
|
1555
|
+
211
|
1556
|
+
212
|
1557
|
+
213</pre>
|
1312
1558
|
</td>
|
1313
1559
|
<td>
|
1314
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line
|
1560
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_sources_client.rb', line 199</span>
|
1315
1561
|
|
1316
1562
|
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
1317
1563
|
<span class='label'>subscription_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
@@ -1338,7 +1584,7 @@
|
|
1338
1584
|
</div>
|
1339
1585
|
|
1340
1586
|
<div id="footer">
|
1341
|
-
Generated on
|
1587
|
+
Generated on Tue Oct 19 15:48:22 2021 by
|
1342
1588
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1343
1589
|
0.9.26 (ruby-3.0.1).
|
1344
1590
|
</div>
|