From 9c8e482eaac522f558f294f2edcc1798c5d06207 Mon Sep 17 00:00:00 2001
From: ngrok-release-bot
Services
@@ -163,8 +163,8 @@API
Services
@@ -169,9 +169,8 @@API
Services
@@ -161,13 +161,13 @@ -
+ Source code for ngrok.datatypes
from __future__ import annotations
from typing import Any, Mapping, Sequence
from .iterator import PagedIterator
-[docs]class Ref(object):
+[docs]class Ref(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -175,8 +175,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<Ref {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<Ref {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<Ref {}>".format(repr(self._props))
@property
def id(self) -> str:
@@ -189,7 +192,7 @@
return self._props["uri"]
-[docs]class AbuseReport(object):
+[docs]class AbuseReport(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -200,8 +203,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<AbuseReport {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<AbuseReport {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<AbuseReport {}>".format(repr(self._props))
@property
def id(self) -> str:
@@ -239,7 +245,7 @@
return self._props["hostnames"]
-[docs]class AbuseReportHostname(object):
+[docs]class AbuseReportHostname(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -247,8 +253,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<AbuseReportHostname {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<AbuseReportHostname {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<AbuseReportHostname {}>".format(repr(self._props))
@property
def hostname(self) -> str:
@@ -261,7 +270,7 @@
return self._props["status"]
-[docs]class APIKey(object):
+[docs]class APIKey(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -269,17 +278,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<APIKey {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<APIKey {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<APIKey {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -321,7 +333,7 @@
return self._props["token"]
-[docs]class APIKeyList(object):
+[docs]class APIKeyList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -330,8 +342,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<APIKeyList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<APIKeyList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<APIKeyList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "keys")
@@ -352,7 +367,7 @@
return self._props["next_page_uri"]
-[docs]class CertificateAuthority(object):
+[docs]class CertificateAuthority(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -360,17 +375,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<CertificateAuthority {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<CertificateAuthority {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<CertificateAuthority {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -437,7 +455,7 @@
return self._props["extended_key_usages"]
-[docs]class CertificateAuthorityList(object):
+[docs]class CertificateAuthorityList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -448,8 +466,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<CertificateAuthorityList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<CertificateAuthorityList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<CertificateAuthorityList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "certificate_authorities")
@@ -470,7 +491,7 @@
return self._props["next_page_uri"]
-[docs]class Credential(object):
+[docs]class Credential(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -478,17 +499,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<Credential {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<Credential {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<Credential {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -537,7 +561,7 @@
return self._props["acl"]
-[docs]class CredentialList(object):
+[docs]class CredentialList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -548,8 +572,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<CredentialList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<CredentialList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<CredentialList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "credentials")
@@ -570,7 +597,7 @@
return self._props["next_page_uri"]
-[docs]class EventStreamList(object):
+[docs]class EventStreamList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -581,8 +608,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EventStreamList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EventStreamList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EventStreamList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "event_streams")
@@ -603,7 +633,7 @@
return self._props["next_page_uri"]
-[docs]class EventStream(object):
+[docs]class EventStream(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -611,17 +641,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EventStream {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EventStream {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EventStream {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
metadata: str = None,
description: str = None,
@@ -684,7 +717,7 @@
return self._props["sampling_rate"]
-[docs]class EventDestination(object):
+[docs]class EventDestination(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -693,10 +726,13 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EventDestination {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EventDestination {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EventDestination {}>".format(repr(self._props))
-[docs] def delete(
+[docs] def delete(
self,
):
self._client.event_destinations.delete(
@@ -739,7 +775,7 @@
return self._props["uri"]
-[docs]class EventDestinationList(object):
+[docs]class EventDestinationList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -750,8 +786,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EventDestinationList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EventDestinationList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EventDestinationList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "event_destinations")
@@ -772,7 +811,7 @@
return self._props["next_page_uri"]
-[docs]class EventTarget(object):
+[docs]class EventTarget(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -785,8 +824,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EventTarget {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EventTarget {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EventTarget {}>".format(repr(self._props))
@property
def firehose(self) -> EventTargetFirehose:
@@ -804,7 +846,7 @@
return self._props["cloudwatch_logs"]
-[docs]class EventTargetFirehose(object):
+[docs]class EventTargetFirehose(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -813,8 +855,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EventTargetFirehose {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EventTargetFirehose {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EventTargetFirehose {}>".format(repr(self._props))
@property
def auth(self) -> AWSAuth:
@@ -827,7 +872,7 @@
return self._props["delivery_stream_arn"]
-[docs]class EventTargetKinesis(object):
+[docs]class EventTargetKinesis(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -836,8 +881,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EventTargetKinesis {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EventTargetKinesis {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EventTargetKinesis {}>".format(repr(self._props))
@property
def auth(self) -> AWSAuth:
@@ -850,7 +898,7 @@
return self._props["stream_arn"]
-[docs]class EventTargetCloudwatchLogs(object):
+[docs]class EventTargetCloudwatchLogs(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -859,8 +907,13 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EventTargetCloudwatchLogs {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EventTargetCloudwatchLogs {} {}>".format(
+ self.id, repr(self._props)
+ )
+ else:
+ return "<EventTargetCloudwatchLogs {}>".format(repr(self._props))
@property
def auth(self) -> AWSAuth:
@@ -873,7 +926,7 @@
return self._props["log_group_arn"]
-[docs]class AWSAuth(object):
+[docs]class AWSAuth(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -883,8 +936,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<AWSAuth {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<AWSAuth {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<AWSAuth {}>".format(repr(self._props))
@property
def role(self) -> AWSRole:
@@ -897,7 +953,7 @@
return self._props["creds"]
-[docs]class AWSRole(object):
+[docs]class AWSRole(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -905,8 +961,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<AWSRole {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<AWSRole {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<AWSRole {}>".format(repr(self._props))
@property
def role_arn(self) -> str:
@@ -914,7 +973,7 @@
return self._props["role_arn"]
-[docs]class AWSCredentials(object):
+[docs]class AWSCredentials(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -922,8 +981,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<AWSCredentials {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<AWSCredentials {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<AWSCredentials {}>".format(repr(self._props))
@property
def aws_access_key_id(self) -> str:
@@ -936,7 +998,7 @@
return self._props["aws_secret_access_key"]
-[docs]class IPPolicy(object):
+[docs]class IPPolicy(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -944,17 +1006,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<IPPolicy {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<IPPolicy {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<IPPolicy {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -996,7 +1061,7 @@
return self._props["action"]
-[docs]class IPPolicyList(object):
+[docs]class IPPolicyList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1005,8 +1070,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<IPPolicyList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<IPPolicyList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<IPPolicyList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ip_policies")
@@ -1027,7 +1095,7 @@
return self._props["next_page_uri"]
-[docs]class IPPolicyRule(object):
+[docs]class IPPolicyRule(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1036,17 +1104,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<IPPolicyRule {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<IPPolicyRule {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<IPPolicyRule {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -1095,7 +1166,7 @@
return self._props["ip_policy"]
-[docs]class IPPolicyRuleList(object):
+[docs]class IPPolicyRuleList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1106,8 +1177,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<IPPolicyRuleList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<IPPolicyRuleList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<IPPolicyRuleList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ip_policy_rules")
@@ -1128,7 +1202,7 @@
return self._props["next_page_uri"]
-[docs]class IPRestriction(object):
+[docs]class IPRestriction(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1137,10 +1211,13 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<IPRestriction {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<IPRestriction {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<IPRestriction {}>".format(repr(self._props))
-[docs] def delete(
+[docs] def delete(
self,
):
self._client.ip_restrictions.delete(
@@ -1188,7 +1265,7 @@
return self._props["ip_policies"]
-[docs]class IPRestrictionList(object):
+[docs]class IPRestrictionList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1199,8 +1276,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<IPRestrictionList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<IPRestrictionList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<IPRestrictionList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ip_restrictions")
@@ -1221,7 +1301,7 @@
return self._props["next_page_uri"]
-[docs]class IPWhitelistEntry(object):
+[docs]class IPWhitelistEntry(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1229,17 +1309,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<IPWhitelistEntry {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<IPWhitelistEntry {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<IPWhitelistEntry {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -1281,7 +1364,7 @@
return self._props["ip_net"]
-[docs]class IPWhitelistEntryList(object):
+[docs]class IPWhitelistEntryList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1292,8 +1375,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<IPWhitelistEntryList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<IPWhitelistEntryList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<IPWhitelistEntryList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "whitelist")
@@ -1314,7 +1400,7 @@
return self._props["next_page_uri"]
-[docs]class EndpointConfiguration(object):
+[docs]class EndpointConfiguration(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1344,17 +1430,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointConfiguration {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointConfiguration {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointConfiguration {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -1480,7 +1569,7 @@
return self._props["oidc"]
-[docs]class EndpointConfigurationList(object):
+[docs]class EndpointConfigurationList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1491,8 +1580,13 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointConfigurationList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointConfigurationList {} {}>".format(
+ self.id, repr(self._props)
+ )
+ else:
+ return "<EndpointConfigurationList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "endpoint_configurations")
@@ -1513,7 +1607,7 @@
return self._props["next_page_uri"]
-[docs]class EndpointWebhookValidation(object):
+[docs]class EndpointWebhookValidation(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1521,8 +1615,13 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointWebhookValidation {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointWebhookValidation {} {}>".format(
+ self.id, repr(self._props)
+ )
+ else:
+ return "<EndpointWebhookValidation {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1540,7 +1639,7 @@
return self._props["secret"]
-[docs]class EndpointCompression(object):
+[docs]class EndpointCompression(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1548,8 +1647,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointCompression {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointCompression {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointCompression {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1557,7 +1659,7 @@
return self._props["enabled"]
-[docs]class EndpointMutualTLS(object):
+[docs]class EndpointMutualTLS(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1568,8 +1670,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointMutualTLS {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointMutualTLS {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointMutualTLS {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1582,7 +1687,7 @@
return self._props["certificate_authorities"]
-[docs]class EndpointMutualTLSMutate(object):
+[docs]class EndpointMutualTLSMutate(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1590,8 +1695,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointMutualTLSMutate {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointMutualTLSMutate {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointMutualTLSMutate {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1604,7 +1712,7 @@
return self._props["certificate_authority_ids"]
-[docs]class EndpointTLSTermination(object):
+[docs]class EndpointTLSTermination(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1612,8 +1720,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointTLSTermination {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointTLSTermination {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointTLSTermination {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1631,7 +1742,7 @@
return self._props["min_version"]
-[docs]class EndpointLogging(object):
+[docs]class EndpointLogging(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1640,8 +1751,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointLogging {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointLogging {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointLogging {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1654,7 +1768,7 @@
return self._props["event_streams"]
-[docs]class EndpointLoggingMutate(object):
+[docs]class EndpointLoggingMutate(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1662,8 +1776,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointLoggingMutate {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointLoggingMutate {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointLoggingMutate {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1676,7 +1793,7 @@
return self._props["event_stream_ids"]
-[docs]class EndpointRequestHeaders(object):
+[docs]class EndpointRequestHeaders(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1684,8 +1801,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointRequestHeaders {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointRequestHeaders {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointRequestHeaders {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1703,7 +1823,7 @@
return self._props["remove"]
-[docs]class EndpointResponseHeaders(object):
+[docs]class EndpointResponseHeaders(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1711,8 +1831,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointResponseHeaders {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointResponseHeaders {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointResponseHeaders {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1730,7 +1853,7 @@
return self._props["remove"]
-[docs]class EndpointIPPolicy(object):
+[docs]class EndpointIPPolicy(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1739,8 +1862,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointIPPolicy {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointIPPolicy {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointIPPolicy {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1752,7 +1878,7 @@
return self._props["ip_policies"]
-[docs]class EndpointIPPolicyMutate(object):
+[docs]class EndpointIPPolicyMutate(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1760,8 +1886,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointIPPolicyMutate {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointIPPolicyMutate {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointIPPolicyMutate {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1774,7 +1903,7 @@
return self._props["ip_policy_ids"]
-[docs]class EndpointCircuitBreaker(object):
+[docs]class EndpointCircuitBreaker(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1782,8 +1911,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointCircuitBreaker {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointCircuitBreaker {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointCircuitBreaker {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1816,7 +1948,7 @@
return self._props["error_threshold_percentage"]
-[docs]class EndpointOAuth(object):
+[docs]class EndpointOAuth(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1825,8 +1957,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointOAuth {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointOAuth {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointOAuth {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -1864,7 +1999,7 @@
return self._props["auth_check_interval"]
-[docs]class EndpointOAuthProvider(object):
+[docs]class EndpointOAuthProvider(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1876,8 +2011,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointOAuthProvider {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointOAuthProvider {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointOAuthProvider {}>".format(repr(self._props))
@property
def github(self) -> EndpointOAuthGitHub:
@@ -1900,7 +2038,7 @@
return self._props["google"]
-[docs]class EndpointOAuthGitHub(object):
+[docs]class EndpointOAuthGitHub(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1908,8 +2046,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointOAuthGitHub {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointOAuthGitHub {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointOAuthGitHub {}>".format(repr(self._props))
@property
def client_id(self) -> str:
@@ -1947,7 +2088,7 @@
return self._props["organizations"]
-[docs]class EndpointOAuthFacebook(object):
+[docs]class EndpointOAuthFacebook(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1955,8 +2096,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointOAuthFacebook {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointOAuthFacebook {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointOAuthFacebook {}>".format(repr(self._props))
@property
def client_id(self) -> str:
@@ -1984,7 +2128,7 @@
return self._props["email_domains"]
-[docs]class EndpointOAuthMicrosoft(object):
+[docs]class EndpointOAuthMicrosoft(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -1992,8 +2136,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointOAuthMicrosoft {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointOAuthMicrosoft {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointOAuthMicrosoft {}>".format(repr(self._props))
@property
def client_id(self) -> str:
@@ -2021,7 +2168,7 @@
return self._props["email_domains"]
-[docs]class EndpointOAuthGoogle(object):
+[docs]class EndpointOAuthGoogle(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2029,8 +2176,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointOAuthGoogle {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointOAuthGoogle {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointOAuthGoogle {}>".format(repr(self._props))
@property
def client_id(self) -> str:
@@ -2058,7 +2208,7 @@
return self._props["email_domains"]
-[docs]class EndpointSAML(object):
+[docs]class EndpointSAML(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2066,8 +2216,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointSAML {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointSAML {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointSAML {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -2140,7 +2293,7 @@
return self._props["metadata_url"]
-[docs]class EndpointSAMLMutate(object):
+[docs]class EndpointSAMLMutate(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2148,8 +2301,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointSAMLMutate {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointSAMLMutate {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointSAMLMutate {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -2197,7 +2353,7 @@
return self._props["authorized_groups"]
-[docs]class EndpointOIDC(object):
+[docs]class EndpointOIDC(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2205,8 +2361,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<EndpointOIDC {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<EndpointOIDC {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<EndpointOIDC {}>".format(repr(self._props))
@property
def enabled(self) -> bool:
@@ -2254,7 +2413,7 @@
return self._props["scopes"]
-[docs]class ReservedAddr(object):
+[docs]class ReservedAddr(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2265,10 +2424,13 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<ReservedAddr {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<ReservedAddr {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<ReservedAddr {}>".format(repr(self._props))
-[docs] def delete(
+[docs] def delete(
self,
):
self._client.reserved_addrs.delete(
@@ -2316,7 +2478,7 @@
return self._props["endpoint_configuration"]
-[docs]class ReservedAddrList(object):
+[docs]class ReservedAddrList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2327,8 +2489,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<ReservedAddrList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<ReservedAddrList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<ReservedAddrList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "reserved_addrs")
@@ -2349,7 +2514,7 @@
return self._props["next_page_uri"]
-[docs]class ReservedDomain(object):
+[docs]class ReservedDomain(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2370,10 +2535,13 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<ReservedDomain {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<ReservedDomain {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<ReservedDomain {}>".format(repr(self._props))
-[docs] def delete(
+[docs] def delete(
self,
):
self._client.reserved_domains.delete(
@@ -2446,7 +2614,7 @@
return self._props["certificate_management_status"]
-[docs]class ReservedDomainList(object):
+[docs]class ReservedDomainList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2457,8 +2625,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<ReservedDomainList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<ReservedDomainList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<ReservedDomainList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "reserved_domains")
@@ -2479,7 +2650,7 @@
return self._props["next_page_uri"]
-[docs]class ReservedDomainCertPolicy(object):
+[docs]class ReservedDomainCertPolicy(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2487,8 +2658,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<ReservedDomainCertPolicy {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<ReservedDomainCertPolicy {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<ReservedDomainCertPolicy {}>".format(repr(self._props))
@property
def authority(self) -> str:
@@ -2501,7 +2675,7 @@
return self._props["private_key_type"]
-[docs]class ReservedDomainCertStatus(object):
+[docs]class ReservedDomainCertStatus(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2512,8 +2686,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<ReservedDomainCertStatus {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<ReservedDomainCertStatus {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<ReservedDomainCertStatus {}>".format(repr(self._props))
@property
def renews_at(self) -> str:
@@ -2526,7 +2703,7 @@
return self._props["provisioning_job"]
-[docs]class ReservedDomainCertNSTarget(object):
+[docs]class ReservedDomainCertNSTarget(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2534,8 +2711,13 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<ReservedDomainCertNSTarget {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<ReservedDomainCertNSTarget {} {}>".format(
+ self.id, repr(self._props)
+ )
+ else:
+ return "<ReservedDomainCertNSTarget {}>".format(repr(self._props))
@property
def zone(self) -> str:
@@ -2548,7 +2730,7 @@
return self._props["nameservers"]
-[docs]class ReservedDomainCertJob(object):
+[docs]class ReservedDomainCertJob(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2559,8 +2741,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<ReservedDomainCertJob {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<ReservedDomainCertJob {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<ReservedDomainCertJob {}>".format(repr(self._props))
@property
def error_code(self) -> str:
@@ -2588,7 +2773,7 @@
return self._props["ns_targets"]
-[docs]class SSHCertificateAuthority(object):
+[docs]class SSHCertificateAuthority(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2596,17 +2781,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<SSHCertificateAuthority {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<SSHCertificateAuthority {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<SSHCertificateAuthority {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -2653,7 +2841,7 @@
return self._props["key_type"]
-[docs]class SSHCertificateAuthorityList(object):
+[docs]class SSHCertificateAuthorityList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2665,8 +2853,13 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<SSHCertificateAuthorityList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<SSHCertificateAuthorityList {} {}>".format(
+ self.id, repr(self._props)
+ )
+ else:
+ return "<SSHCertificateAuthorityList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ssh_certificate_authorities")
@@ -2687,7 +2880,7 @@
return self._props["next_page_uri"]
-[docs]class SSHCredential(object):
+[docs]class SSHCredential(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2695,17 +2888,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<SSHCredential {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<SSHCredential {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<SSHCredential {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -2754,7 +2950,7 @@
return self._props["acl"]
-[docs]class SSHCredentialList(object):
+[docs]class SSHCredentialList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2765,8 +2961,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<SSHCredentialList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<SSHCredentialList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<SSHCredentialList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ssh_credentials")
@@ -2787,7 +2986,7 @@
return self._props["next_page_uri"]
-[docs]class SSHHostCertificate(object):
+[docs]class SSHHostCertificate(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2795,17 +2994,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<SSHHostCertificate {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<SSHHostCertificate {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<SSHHostCertificate {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -2877,7 +3079,7 @@
return self._props["certificate"]
-[docs]class SSHHostCertificateList(object):
+[docs]class SSHHostCertificateList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2888,8 +3090,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<SSHHostCertificateList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<SSHHostCertificateList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<SSHHostCertificateList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ssh_host_certificates")
@@ -2910,7 +3115,7 @@
return self._props["next_page_uri"]
-[docs]class SSHUserCertificate(object):
+[docs]class SSHUserCertificate(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -2918,17 +3123,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<SSHUserCertificate {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<SSHUserCertificate {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<SSHUserCertificate {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -3010,7 +3218,7 @@
return self._props["certificate"]
-[docs]class SSHUserCertificateList(object):
+[docs]class SSHUserCertificateList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -3021,8 +3229,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<SSHUserCertificateList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<SSHUserCertificateList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<SSHUserCertificateList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "ssh_user_certificates")
@@ -3043,7 +3254,7 @@
return self._props["next_page_uri"]
-[docs]class TLSCertificate(object):
+[docs]class TLSCertificate(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -3054,17 +3265,20 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<TLSCertificate {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<TLSCertificate {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<TLSCertificate {}>".format(repr(self._props))
-[docs] def delete(
+
-[docs] def update(
+[docs] def update(
self,
description: str = None,
metadata: str = None,
@@ -3181,7 +3395,7 @@
return self._props["subject_country"]
-[docs]class TLSCertificateList(object):
+[docs]class TLSCertificateList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -3192,8 +3406,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<TLSCertificateList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<TLSCertificateList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<TLSCertificateList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "tls_certificates")
@@ -3214,7 +3431,7 @@
return self._props["next_page_uri"]
-[docs]class TLSCertificateSANs(object):
+[docs]class TLSCertificateSANs(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -3222,8 +3439,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<TLSCertificateSANs {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<TLSCertificateSANs {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<TLSCertificateSANs {}>".format(repr(self._props))
@property
def dns_names(self) -> Sequence[str]:
@@ -3236,7 +3456,7 @@
return self._props["ips"]
-[docs]class TunnelSession(object):
+[docs]class TunnelSession(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -3245,8 +3465,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<TunnelSession {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<TunnelSession {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<TunnelSession {}>".format(repr(self._props))
@property
def agent_version(self) -> str:
@@ -3299,7 +3522,7 @@
return self._props["uri"]
-[docs]class TunnelSessionList(object):
+[docs]class TunnelSessionList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -3310,8 +3533,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<TunnelSessionList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<TunnelSessionList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<TunnelSessionList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "tunnel_sessions")
@@ -3332,7 +3558,7 @@
return self._props["next_page_uri"]
-[docs]class Tunnel(object):
+[docs]class Tunnel(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -3341,8 +3567,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<Tunnel {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<Tunnel {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<Tunnel {}>".format(repr(self._props))
@property
def id(self) -> str:
@@ -3380,7 +3609,7 @@
return self._props["tunnel_session"]
-[docs]class TunnelList(object):
+[docs]class TunnelList(object):
def __init__(self, client, props):
self._client = client
self._props = props
@@ -3389,8 +3618,11 @@
def __eq__(self, other):
return self._props == other._props
- def __repr__(self):
- return "<TunnelList {}>".format(self.id)
+ def __str__(self):
+ if "id" in self._props:
+ return "<TunnelList {} {}>".format(self.id, repr(self._props))
+ else:
+ return "<TunnelList {}>".format(repr(self._props))
def __iter__(self):
return PagedIterator(self._client, self, "tunnels")
diff --git a/docs/_modules/ngrok/error.html b/docs/_modules/ngrok/error.html
index 57856f7..27cd0c0 100644
--- a/docs/_modules/ngrok/error.html
+++ b/docs/_modules/ngrok/error.html
@@ -110,7 +110,7 @@
API
Services
@@ -187,7 +187,15 @@
super().__init__(self, message)
self.error_code = error_code
self.http_status_code = http_status_code
- self.details = details
+ self.details = details
+
+ @property
+ def operation_id(self):
+ """
+ OperationID returns the unique trace ID assigned by ngrok to this API
+ request.
+ """
+ return self.details.get("operation_id")
[docs]class NotFoundError(Error):
diff --git a/docs/_modules/ngrok/services.html b/docs/_modules/ngrok/services.html
index 5e5557a..a2763b0 100644
--- a/docs/_modules/ngrok/services.html
+++ b/docs/_modules/ngrok/services.html
@@ -110,7 +110,7 @@
API
Services
@@ -166,8 +166,8 @@
from collections.abc import Iterator
from typing import Any, Mapping, Sequence
-from .api_client import APIClient
-from .objects import *
+from .http_client import HTTPClient
+from .datatypes import *
[docs]class AbuseReportsClient(object):
@@ -183,9 +183,11 @@
:param urls: a list of URLs containing suspected abusive content
:param metadata: arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
+
+ https://ngrok.com/docs/api#api-abuse-reports-create
"""
path = "/abuse_reports"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
urls=urls,
@@ -201,12 +203,14 @@
"""Get the detailed status of abuse report by ID.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-abuse-reports-get
"""
path = "/abuse_reports/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return AbuseReport(self._client, result)
@@ -223,9 +227,11 @@
:param description: human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
:param metadata: arbitrary user-defined data of this API key. optional, max 4096 bytes
+
+ https://ngrok.com/docs/api#api-api-keys-create
"""
path = "/api_keys"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -241,12 +247,14 @@
"""Delete an API key by ID
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-api-keys-delete
"""
path = "/api_keys/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -255,12 +263,14 @@
"""Get the details of an API key by ID.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-api-keys-get
"""
path = "/api_keys/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return APIKey(self._client, result)
[docs] def list(
@@ -272,9 +282,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-api-keys-list
"""
path = "/api_keys"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -294,12 +306,14 @@
:param id:
:param description: human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
:param metadata: arbitrary user-defined data of this API key. optional, max 4096 bytes
+
+ https://ngrok.com/docs/api#api-api-keys-update
"""
path = "/api_keys/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -324,9 +338,11 @@
:param description: human-readable description of this Certificate Authority. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
:param ca_pem: raw PEM of the Certificate Authority
+
+ https://ngrok.com/docs/api#api-certificate-authorities-create
"""
path = "/certificate_authorities"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -343,12 +359,14 @@
"""Delete a Certificate Authority
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-certificate-authorities-delete
"""
path = "/certificate_authorities/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -357,12 +375,14 @@
"""Get detailed information about a certficate authority
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-certificate-authorities-get
"""
path = "/certificate_authorities/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return CertificateAuthority(self._client, result)
[docs] def list(
@@ -374,9 +394,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-certificate-authorities-list
"""
path = "/certificate_authorities"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -396,12 +418,14 @@
:param id:
:param description: human-readable description of this Certificate Authority. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
+
+ https://ngrok.com/docs/api#api-certificate-authorities-update
"""
path = "/certificate_authorities/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -426,9 +450,11 @@
:param description: human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
+
+ https://ngrok.com/docs/api#api-credentials-create
"""
path = "/credentials"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -445,12 +471,14 @@
"""Delete a tunnel authtoken credential by ID
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-credentials-delete
"""
path = "/credentials/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -459,12 +487,14 @@
"""Get detailed information about a tunnel authtoken credential
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-credentials-get
"""
path = "/credentials/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return Credential(self._client, result)
[docs] def list(
@@ -476,9 +506,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-credentials-list
"""
path = "/credentials"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -500,12 +532,14 @@
:param description: human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
+
+ https://ngrok.com/docs/api#api-credentials-update
"""
path = "/credentials/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -537,9 +571,11 @@
:param event_type: The protocol that determines which events will be collected. Supported values are ``tcp_connection_closed`` and ``http_request_complete``.
:param destination_ids: A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
:param sampling_rate: The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.
+
+ https://ngrok.com/docs/api#api-event-streams-create
"""
path = "/event_streams"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
metadata=metadata,
@@ -559,12 +595,14 @@
"""Delete an Event Stream. Associated Event Destinations will be preserved.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-event-streams-delete
"""
path = "/event_streams/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -573,12 +611,14 @@
"""Get detailed information about an Event Stream by ID.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-event-streams-get
"""
path = "/event_streams/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EventStream(self._client, result)
[docs] def list(
@@ -590,9 +630,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-event-streams-list
"""
path = "/event_streams"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -618,12 +660,14 @@
:param fields: A list of protocol-specific fields you want to collect on each event.
:param destination_ids: A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
:param sampling_rate: The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.
+
+ https://ngrok.com/docs/api#api-event-streams-update
"""
path = "/event_streams/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
metadata=metadata,
@@ -653,9 +697,11 @@
:param description: Human-readable description of the Event Destination. Optional, max 255 bytes.
:param format: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is ``JSON``.
:param target: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: ``kinesis``, ``firehose``, ``cloudwatch_logs``, or ``s3``.
+
+ https://ngrok.com/docs/api#api-event-destinations-create
"""
path = "/event_destinations"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
metadata=metadata,
@@ -673,12 +719,14 @@
"""Delete an Event Destination. If the Event Destination is still referenced by an Event Stream, this will throw an error until that Event Stream has removed that reference.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-event-destinations-delete
"""
path = "/event_destinations/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -687,12 +735,14 @@
"""Get detailed information about an Event Destination by ID.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-event-destinations-get
"""
path = "/event_destinations/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EventDestination(self._client, result)
[docs] def list(
@@ -704,9 +754,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-event-destinations-list
"""
path = "/event_destinations"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -730,12 +782,14 @@
:param description: Human-readable description of the Event Destination. Optional, max 255 bytes.
:param format: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is ``JSON``.
:param target: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: ``kinesis``, ``firehose``, ``cloudwatch_logs``, or ``s3``.
+
+ https://ngrok.com/docs/api#api-event-destinations-update
"""
path = "/event_destinations/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
metadata=metadata,
@@ -762,9 +816,11 @@
:param description: human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
:param action: the IP policy action. Supported values are ``allow`` or ``deny``
+
+ https://ngrok.com/docs/api#api-ip-policies-create
"""
path = "/ip_policies"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -781,12 +837,14 @@
"""Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ip-policies-delete
"""
path = "/ip_policies/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -795,12 +853,14 @@
"""Get detailed information about an IP policy by ID.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ip-policies-get
"""
path = "/ip_policies/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return IPPolicy(self._client, result)
[docs] def list(
@@ -812,9 +872,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-ip-policies-list
"""
path = "/ip_policies"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -834,12 +896,14 @@
:param id:
:param description: human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
+
+ https://ngrok.com/docs/api#api-ip-policies-update
"""
path = "/ip_policies/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -866,9 +930,11 @@
:param metadata: arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
:param cidr: an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
:param ip_policy_id: ID of the IP policy this IP policy rule will be attached to
+
+ https://ngrok.com/docs/api#api-ip-policy-rules-create
"""
path = "/ip_policy_rules"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -886,12 +952,14 @@
"""Delete an IP policy rule.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ip-policy-rules-delete
"""
path = "/ip_policy_rules/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -900,12 +968,14 @@
"""Get detailed information about an IP policy rule by ID.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ip-policy-rules-get
"""
path = "/ip_policy_rules/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return IPPolicyRule(self._client, result)
[docs] def list(
@@ -917,9 +987,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-ip-policy-rules-list
"""
path = "/ip_policy_rules"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -941,12 +1013,14 @@
:param description: human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
:param cidr: an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
+
+ https://ngrok.com/docs/api#api-ip-policy-rules-update
"""
path = "/ip_policy_rules/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -976,9 +1050,11 @@
:param enforced: true if the IP restriction will be enforce. if false, only warnings will be issued
:param type: the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: ``dashboard``, ``api``, ``agent``, and ``endpoints``
:param ip_policy_ids: the set of IP policy identifiers that are used to enforce the restriction
+
+ https://ngrok.com/docs/api#api-ip-restrictions-create
"""
path = "/ip_restrictions"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -997,12 +1073,14 @@
"""Delete an IP restriction
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ip-restrictions-delete
"""
path = "/ip_restrictions/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -1011,12 +1089,14 @@
"""Get detailed information about an IP restriction
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ip-restrictions-get
"""
path = "/ip_restrictions/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return IPRestriction(self._client, result)
[docs] def list(
@@ -1028,9 +1108,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-ip-restrictions-list
"""
path = "/ip_restrictions"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -1054,12 +1136,14 @@
:param metadata: arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
:param enforced: true if the IP restriction will be enforce. if false, only warnings will be issued
:param ip_policy_ids: the set of IP policy identifiers that are used to enforce the restriction
+
+ https://ngrok.com/docs/api#api-ip-restrictions-update
"""
path = "/ip_restrictions/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -1086,9 +1170,11 @@
:param description: human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
:param ip_net: an IP address or IP network range in CIDR notation (e.g. 10.1.1.1 or 10.1.0.0/16) of addresses that will be whitelisted to communicate with your tunnel endpoints
+
+ https://ngrok.com/docs/api#api-ip-whitelist-create
"""
path = "/ip_whitelist"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -1105,12 +1191,14 @@
"""Delete an IP whitelist entry.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ip-whitelist-delete
"""
path = "/ip_whitelist/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -1119,12 +1207,14 @@
"""Get detailed information about an IP whitelist entry by ID.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ip-whitelist-get
"""
path = "/ip_whitelist/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return IPWhitelistEntry(self._client, result)
[docs] def list(
@@ -1136,9 +1226,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-ip-whitelist-list
"""
path = "/ip_whitelist"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -1158,12 +1250,14 @@
:param id:
:param description: human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.
+
+ https://ngrok.com/docs/api#api-ip-whitelist-update
"""
path = "/ip_whitelist/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -1215,9 +1309,11 @@
:param logging: logging module configuration or ``null``
:param saml: saml module configuration or ``null``
:param oidc: oidc module configuration or ``null``
+
+ https://ngrok.com/docs/api#api-endpoint-configurations-create
"""
path = "/endpoint_configurations"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
type=type,
@@ -1246,12 +1342,14 @@
"""Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-configurations-delete
"""
path = "/endpoint_configurations/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -1260,12 +1358,14 @@
"""Returns detailed information about an endpoint configuration
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-configurations-get
"""
path = "/endpoint_configurations/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointConfiguration(self._client, result)
[docs] def list(
@@ -1277,9 +1377,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-endpoint-configurations-list
"""
path = "/endpoint_configurations"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -1323,12 +1425,14 @@
:param logging: logging module configuration or ``null``
:param saml: saml module configuration or ``null``
:param oidc: oidc module configuration or ``null``
+
+ https://ngrok.com/docs/api#api-endpoint-configurations-update
"""
path = "/endpoint_configurations/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -1363,12 +1467,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-logging-module-replace
"""
path = "/endpoint_configurations/{id}/logging"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1383,12 +1489,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-logging-module-get
"""
path = "/endpoint_configurations/{id}/logging"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointLogging(self._client, result)
[docs] def delete(
@@ -1398,12 +1506,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-logging-module-delete
"""
path = "/endpoint_configurations/{id}/logging"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointCircuitBreakerModuleClient(object):
@@ -1419,12 +1529,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-replace
"""
path = "/endpoint_configurations/{id}/circuit_breaker"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1439,12 +1551,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-get
"""
path = "/endpoint_configurations/{id}/circuit_breaker"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointCircuitBreaker(self._client, result)
[docs] def delete(
@@ -1454,12 +1568,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-circuit-breaker-module-delete
"""
path = "/endpoint_configurations/{id}/circuit_breaker"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointCompressionModuleClient(object):
@@ -1475,12 +1591,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-compression-module-replace
"""
path = "/endpoint_configurations/{id}/compression"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1495,12 +1613,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-compression-module-get
"""
path = "/endpoint_configurations/{id}/compression"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointCompression(self._client, result)
[docs] def delete(
@@ -1510,12 +1630,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-compression-module-delete
"""
path = "/endpoint_configurations/{id}/compression"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointTLSTerminationModuleClient(object):
@@ -1531,12 +1653,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-tls-termination-module-replace
"""
path = "/endpoint_configurations/{id}/tls_termination"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1551,12 +1675,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-tls-termination-module-get
"""
path = "/endpoint_configurations/{id}/tls_termination"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointTLSTermination(self._client, result)
[docs] def delete(
@@ -1566,12 +1692,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-tls-termination-module-delete
"""
path = "/endpoint_configurations/{id}/tls_termination"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointIPPolicyModuleClient(object):
@@ -1587,12 +1715,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-ip-policy-module-replace
"""
path = "/endpoint_configurations/{id}/ip_policy"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1607,12 +1737,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-ip-policy-module-get
"""
path = "/endpoint_configurations/{id}/ip_policy"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointIPPolicy(self._client, result)
[docs] def delete(
@@ -1622,12 +1754,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-ip-policy-module-delete
"""
path = "/endpoint_configurations/{id}/ip_policy"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointMutualTLSModuleClient(object):
@@ -1643,12 +1777,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-replace
"""
path = "/endpoint_configurations/{id}/mutual_tls"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1663,12 +1799,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-get
"""
path = "/endpoint_configurations/{id}/mutual_tls"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointMutualTLS(self._client, result)
[docs] def delete(
@@ -1678,12 +1816,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-mutual-tls-module-delete
"""
path = "/endpoint_configurations/{id}/mutual_tls"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointRequestHeadersModuleClient(object):
@@ -1699,12 +1839,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-request-headers-module-replace
"""
path = "/endpoint_configurations/{id}/request_headers"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1719,12 +1861,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-request-headers-module-get
"""
path = "/endpoint_configurations/{id}/request_headers"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointRequestHeaders(self._client, result)
[docs] def delete(
@@ -1734,12 +1878,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-request-headers-module-delete
"""
path = "/endpoint_configurations/{id}/request_headers"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointResponseHeadersModuleClient(object):
@@ -1755,12 +1901,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-response-headers-module-replace
"""
path = "/endpoint_configurations/{id}/response_headers"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1775,12 +1923,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-response-headers-module-get
"""
path = "/endpoint_configurations/{id}/response_headers"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointResponseHeaders(self._client, result)
[docs] def delete(
@@ -1790,12 +1940,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-response-headers-module-delete
"""
path = "/endpoint_configurations/{id}/response_headers"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointOAuthModuleClient(object):
@@ -1811,12 +1963,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-o-auth-module-replace
"""
path = "/endpoint_configurations/{id}/oauth"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1831,12 +1985,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-o-auth-module-get
"""
path = "/endpoint_configurations/{id}/oauth"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointOAuth(self._client, result)
[docs] def delete(
@@ -1846,12 +2002,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-o-auth-module-delete
"""
path = "/endpoint_configurations/{id}/oauth"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointWebhookValidationModuleClient(object):
@@ -1867,12 +2025,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-replace
"""
path = "/endpoint_configurations/{id}/webhook_validation"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1887,12 +2047,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-get
"""
path = "/endpoint_configurations/{id}/webhook_validation"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointWebhookValidation(self._client, result)
[docs] def delete(
@@ -1902,12 +2064,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-webhook-validation-module-delete
"""
path = "/endpoint_configurations/{id}/webhook_validation"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointSAMLModuleClient(object):
@@ -1923,12 +2087,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-saml-module-replace
"""
path = "/endpoint_configurations/{id}/saml"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1943,12 +2109,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-saml-module-get
"""
path = "/endpoint_configurations/{id}/saml"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointSAML(self._client, result)
[docs] def delete(
@@ -1958,12 +2126,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-saml-module-delete
"""
path = "/endpoint_configurations/{id}/saml"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class EndpointOIDCModuleClient(object):
@@ -1979,12 +2149,14 @@
:param id:
:param module:
+
+ https://ngrok.com/docs/api#api-endpoint-oidc-module-replace
"""
path = "/endpoint_configurations/{id}/oidc"
path = path.format(
id=id,
)
- result = self._client.api_client.put(
+ result = self._client.http_client.put(
path,
dict(
module=module,
@@ -1999,12 +2171,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-oidc-module-get
"""
path = "/endpoint_configurations/{id}/oidc"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return EndpointOIDC(self._client, result)
[docs] def delete(
@@ -2014,12 +2188,14 @@
"""
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-endpoint-oidc-module-delete
"""
path = "/endpoint_configurations/{id}/oidc"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class ReservedAddrsClient(object):
@@ -2039,9 +2215,11 @@
:param metadata: arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
:param region: reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
:param endpoint_configuration_id: ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
+
+ https://ngrok.com/docs/api#api-reserved-addrs-create
"""
path = "/reserved_addrs"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -2059,12 +2237,14 @@
"""Delete a reserved address.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-reserved-addrs-delete
"""
path = "/reserved_addrs/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -2073,12 +2253,14 @@
"""Get the details of a reserved address.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-reserved-addrs-get
"""
path = "/reserved_addrs/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return ReservedAddr(self._client, result)
[docs] def list(
@@ -2090,9 +2272,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-reserved-addrs-list
"""
path = "/reserved_addrs"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -2114,12 +2298,14 @@
:param description: human-readable description of what this reserved address will be used for
:param metadata: arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
:param endpoint_configuration_id: ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
+
+ https://ngrok.com/docs/api#api-reserved-addrs-update
"""
path = "/reserved_addrs/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -2136,12 +2322,14 @@
"""Detach the endpoint configuration attached to a reserved address.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-reserved-addrs-delete-endpoint-config
"""
path = "/reserved_addrs/{id}/endpoint_configuration"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class ReservedDomainsClient(object):
@@ -2169,9 +2357,11 @@
:param https_endpoint_configuration_id: ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
:param certificate_id: ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
:param 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``.
+
+ https://ngrok.com/docs/api#api-reserved-domains-create
"""
path = "/reserved_domains"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
name=name,
@@ -2193,12 +2383,14 @@
"""Delete a reserved domain.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-reserved-domains-delete
"""
path = "/reserved_domains/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -2207,12 +2399,14 @@
"""Get the details of a reserved domain.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-reserved-domains-get
"""
path = "/reserved_domains/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return ReservedDomain(self._client, result)
[docs] def list(
@@ -2224,9 +2418,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-reserved-domains-list
"""
path = "/reserved_domains"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -2254,12 +2450,14 @@
:param https_endpoint_configuration_id: ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
:param certificate_id: ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
:param 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``.
+
+ https://ngrok.com/docs/api#api-reserved-domains-update
"""
path = "/reserved_domains/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -2279,12 +2477,14 @@
"""Detach the certificate management policy attached to a reserved domain.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy
"""
path = "/reserved_domains/{id}/certificate_management_policy"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def delete_certificate(
self,
@@ -2293,12 +2493,14 @@
"""Detach the certificate attached to a reserved domain.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-reserved-domains-delete-certificate
"""
path = "/reserved_domains/{id}/certificate"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def delete_http_endpoint_config(
self,
@@ -2307,12 +2509,14 @@
"""Detach the http endpoint configuration attached to a reserved domain.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config
"""
path = "/reserved_domains/{id}/http_endpoint_configuration"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def delete_https_endpoint_config(
self,
@@ -2321,12 +2525,14 @@
"""Detach the https endpoint configuration attached to a reserved domain.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config
"""
path = "/reserved_domains/{id}/https_endpoint_configuration"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs]class SSHCertificateAuthoritiesClient(object):
@@ -2348,9 +2554,11 @@
:param private_key_type: the type of private key to generate. one of ``rsa``, ``ecdsa``, ``ed25519``
:param elliptic_curve: the type of elliptic curve to use when creating an ECDSA key
:param key_size: the key size to use when creating an RSA key. one of ``2048`` or ``4096``
+
+ https://ngrok.com/docs/api#api-ssh-certificate-authorities-create
"""
path = "/ssh_certificate_authorities"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -2369,12 +2577,14 @@
"""Delete an SSH Certificate Authority
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete
"""
path = "/ssh_certificate_authorities/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -2383,12 +2593,14 @@
"""Get detailed information about an SSH Certficate Authority
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ssh-certificate-authorities-get
"""
path = "/ssh_certificate_authorities/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return SSHCertificateAuthority(self._client, result)
[docs] def list(
@@ -2400,9 +2612,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-ssh-certificate-authorities-list
"""
path = "/ssh_certificate_authorities"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -2422,12 +2636,14 @@
:param id:
:param description: human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
+
+ https://ngrok.com/docs/api#api-ssh-certificate-authorities-update
"""
path = "/ssh_certificate_authorities/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -2454,9 +2670,11 @@
:param metadata: arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
:param public_key: the PEM-encoded public key of the SSH keypair that will be used to authenticate
+
+ https://ngrok.com/docs/api#api-ssh-credentials-create
"""
path = "/ssh_credentials"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -2474,12 +2692,14 @@
"""Delete an ssh_credential by ID
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ssh-credentials-delete
"""
path = "/ssh_credentials/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -2488,12 +2708,14 @@
"""Get detailed information about an ssh_credential
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ssh-credentials-get
"""
path = "/ssh_credentials/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return SSHCredential(self._client, result)
[docs] def list(
@@ -2505,9 +2727,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-ssh-credentials-list
"""
path = "/ssh_credentials"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -2529,12 +2753,14 @@
:param description: human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
+
+ https://ngrok.com/docs/api#api-ssh-credentials-update
"""
path = "/ssh_credentials/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -2568,9 +2794,11 @@
:param valid_until: The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this ``valid_before``.
:param description: human-readable description of this SSH Host Certificate. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
+
+ https://ngrok.com/docs/api#api-ssh-host-certificates-create
"""
path = "/ssh_host_certificates"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
ssh_certificate_authority_id=ssh_certificate_authority_id,
@@ -2591,12 +2819,14 @@
"""Delete an SSH Host Certificate
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ssh-host-certificates-delete
"""
path = "/ssh_host_certificates/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -2605,12 +2835,14 @@
"""Get detailed information about an SSH Host Certficate
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ssh-host-certificates-get
"""
path = "/ssh_host_certificates/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return SSHHostCertificate(self._client, result)
[docs] def list(
@@ -2622,9 +2854,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-ssh-host-certificates-list
"""
path = "/ssh_host_certificates"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -2644,12 +2878,14 @@
:param id:
:param description: human-readable description of this SSH Host Certificate. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
+
+ https://ngrok.com/docs/api#api-ssh-host-certificates-update
"""
path = "/ssh_host_certificates/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -2686,9 +2922,11 @@
:param valid_until: The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this ``valid_before``.
:param description: human-readable description of this SSH User Certificate. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
+
+ https://ngrok.com/docs/api#api-ssh-user-certificates-create
"""
path = "/ssh_user_certificates"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
ssh_certificate_authority_id=ssh_certificate_authority_id,
@@ -2711,12 +2949,14 @@
"""Delete an SSH User Certificate
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ssh-user-certificates-delete
"""
path = "/ssh_user_certificates/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -2725,12 +2965,14 @@
"""Get detailed information about an SSH User Certficate
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-ssh-user-certificates-get
"""
path = "/ssh_user_certificates/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return SSHUserCertificate(self._client, result)
[docs] def list(
@@ -2742,9 +2984,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-ssh-user-certificates-list
"""
path = "/ssh_user_certificates"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -2764,12 +3008,14 @@
:param id:
:param description: human-readable description of this SSH User Certificate. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
+
+ https://ngrok.com/docs/api#api-ssh-user-certificates-update
"""
path = "/ssh_user_certificates/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -2796,9 +3042,11 @@
:param metadata: arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
:param certificate_pem: chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` <https://ngrok.com/docs/api#tls-certificates-pem>`_.
:param private_key_pem: private key for the TLS certificate, PEM-encoded. See `Private Keys` <https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_.
+
+ https://ngrok.com/docs/api#api-tls-certificates-create
"""
path = "/tls_certificates"
- result = self._client.api_client.post(
+ result = self._client.http_client.post(
path,
dict(
description=description,
@@ -2816,12 +3064,14 @@
"""Delete a TLS certificate
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-tls-certificates-delete
"""
path = "/tls_certificates/{id}"
path = path.format(
id=id,
)
- self._client.api_client.delete(path, dict())
+ self._client.http_client.delete(path, dict())
[docs] def get(
self,
@@ -2830,12 +3080,14 @@
"""Get detailed information about a TLS certificate
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-tls-certificates-get
"""
path = "/tls_certificates/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return TLSCertificate(self._client, result)
[docs] def list(
@@ -2847,9 +3099,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-tls-certificates-list
"""
path = "/tls_certificates"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -2869,12 +3123,14 @@
:param id:
:param description: human-readable description of this TLS certificate. optional, max 255 bytes.
:param metadata: arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
+
+ https://ngrok.com/docs/api#api-tls-certificates-update
"""
path = "/tls_certificates/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.patch(
+ result = self._client.http_client.patch(
path,
dict(
description=description,
@@ -2897,9 +3153,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-tunnel-sessions-list
"""
path = "/tunnel_sessions"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
@@ -2915,12 +3173,14 @@
"""Get the detailed status of a tunnel session by ID
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-tunnel-sessions-get
"""
path = "/tunnel_sessions/{id}"
path = path.format(
id=id,
)
- result = self._client.api_client.get(path, dict())
+ result = self._client.http_client.get(path, dict())
return TunnelSession(self._client, result)
[docs] def restart(
@@ -2930,12 +3190,14 @@
"""Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-tunnel-sessions-restart
"""
path = "/tunnel_sessions/{id}/restart"
path = path.format(
id=id,
)
- self._client.api_client.post(path, dict())
+ self._client.http_client.post(path, dict())
[docs] def stop(
self,
@@ -2944,12 +3206,14 @@
"""Issues a command instructing the ngrok agent that started this tunnel session to exit.
:param id: a resource identifier
+
+ https://ngrok.com/docs/api#api-tunnel-sessions-stop
"""
path = "/tunnel_sessions/{id}/stop"
path = path.format(
id=id,
)
- self._client.api_client.post(path, dict())
+ self._client.http_client.post(path, dict())
[docs] def update(
self,
@@ -2958,12 +3222,14 @@
"""Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted
:param id:
+
+ https://ngrok.com/docs/api#api-tunnel-sessions-update
"""
path = "/tunnel_sessions/{id}/update"
path = path.format(
id=id,
)
- self._client.api_client.post(path, dict())
+ self._client.http_client.post(path, dict())
[docs]class TunnelsClient(object):
@@ -2979,9 +3245,11 @@
:param before_id:
:param limit:
+
+ https://ngrok.com/docs/api#api-tunnels-list
"""
path = "/tunnels"
- result = self._client.api_client.get(
+ result = self._client.http_client.get(
path,
dict(
before_id=before_id,
diff --git a/docs/_sources/datatypes.rst.txt b/docs/_sources/datatypes.rst.txt
new file mode 100644
index 0000000..7db4f9d
--- /dev/null
+++ b/docs/_sources/datatypes.rst.txt
@@ -0,0 +1,8 @@
+Datatypes
+=====================================
+
+This module contains all datatypes returned by the ngrok API.
+
+.. automodule:: ngrok.datatypes
+ :members:
+ :undoc-members:
diff --git a/docs/_sources/errors.rst.txt b/docs/_sources/errors.rst.txt
index 762bbd5..036eca6 100644
--- a/docs/_sources/errors.rst.txt
+++ b/docs/_sources/errors.rst.txt
@@ -36,7 +36,7 @@ documentation for the `list of all ngrok error codes API
Services
@@ -179,8 +179,11 @@
metadata (str) – arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
-Return type
-
+
+https://ngrok.com/docs/api#api-abuse-reports-create
+
+- Return type
+-
@@ -192,8 +195,11 @@
Parameters
id (str) – a resource identifier
-Return type
-
+
+https://ngrok.com/docs/api#api-abuse-reports-get
+
+- Return type
+-
diff --git a/docs/api_keys.html b/docs/api_keys.html
index 0737441..62a36db 100644
--- a/docs/api_keys.html
+++ b/docs/api_keys.html
@@ -110,7 +110,7 @@
API
Services
@@ -179,8 +179,11 @@
metadata (str) – arbitrary user-defined data of this API key. optional, max 4096 bytes
-Return type
-
+
+https://ngrok.com/docs/api#api-api-keys-create
+
+- Return type
+-
@@ -193,6 +196,7 @@
id (str) – a resource identifier
+https://ngrok.com/docs/api#api-api-keys-delete
-
@@ -202,8 +206,11 @@
- Parameters
id (str) – a resource identifier
-- Return type
--
+
+https://ngrok.com/docs/api#api-api-keys-get
+
+- Return type
+-
@@ -218,8 +225,11 @@
limit (Optional[str]) –
-Return type
-
+
+https://ngrok.com/docs/api#api-api-keys-list
+
+- Return type
+-
@@ -235,8 +245,11 @@
metadata (Optional[str]) – arbitrary user-defined data of this API key. optional, max 4096 bytes
-Return type
-
+
+https://ngrok.com/docs/api#api-api-keys-update
+
+- Return type
+-
diff --git a/docs/certificate_authorities.html b/docs/certificate_authorities.html
index 099f4ef..171fa80 100644
--- a/docs/certificate_authorities.html
+++ b/docs/certificate_authorities.html
@@ -110,7 +110,7 @@
API
Services
@@ -180,8 +180,11 @@
ca_pem (str) – raw PEM of the Certificate Authority
-Return type
-
+
+https://ngrok.com/docs/api#api-certificate-authorities-create
+
+- Return type
+-
@@ -194,6 +197,7 @@
id (str) – a resource identifier
+https://ngrok.com/docs/api#api-certificate-authorities-delete
-
@@ -203,8 +207,11 @@
- Parameters
id (str) – a resource identifier
-- Return type
--
+
+https://ngrok.com/docs/api#api-certificate-authorities-get
+
+- Return type
+-
@@ -219,8 +226,11 @@
limit (Optional[str]) –
-Return type
-
+
+https://ngrok.com/docs/api#api-certificate-authorities-list
+
+- Return type
+-
@@ -236,8 +246,11 @@
metadata (Optional[str]) – arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
-Return type
-
+
+https://ngrok.com/docs/api#api-certificate-authorities-update
+
+- Return type
+-
diff --git a/docs/client.html b/docs/client.html
index 0958109..9d6e7b9 100644
--- a/docs/client.html
+++ b/docs/client.html
@@ -2,7 +2,7 @@
-
+
Client - ngrok-api documentation
@@ -110,7 +110,7 @@
API
Services
@@ -182,7 +182,7 @@ Client object: