@ngrok/ngrok-api 0.0.9 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (218) hide show
  1. package/.eslintrc.js +4 -1
  2. package/CHANGELOG.md +34 -0
  3. package/README.md +148 -2
  4. package/docs/CNAME +1 -0
  5. package/docs/assets/css/main.css +2660 -0
  6. package/docs/assets/images/icons.png +0 -0
  7. package/docs/assets/images/icons@2x.png +0 -0
  8. package/docs/assets/images/widgets.png +0 -0
  9. package/docs/assets/images/widgets@2x.png +0 -0
  10. package/docs/assets/js/main.js +248 -0
  11. package/docs/assets/js/search.js +1 -0
  12. package/docs/classes/client.Ngrok.html +681 -0
  13. package/docs/classes/services.APIKeys.html +453 -0
  14. package/docs/classes/services.AbuseReports.html +360 -0
  15. package/docs/classes/services.AgentIngresses.html +442 -0
  16. package/docs/classes/services.CertificateAuthorities.html +453 -0
  17. package/docs/classes/services.Credentials.html +452 -0
  18. package/docs/classes/services.EndpointCircuitBreakerModule.html +369 -0
  19. package/docs/classes/services.EndpointCompressionModule.html +369 -0
  20. package/docs/classes/services.EndpointConfigurations.html +451 -0
  21. package/docs/classes/services.EndpointIPPolicyModule.html +369 -0
  22. package/docs/classes/services.EndpointLoggingModule.html +369 -0
  23. package/docs/classes/services.EndpointMutualTLSModule.html +369 -0
  24. package/docs/classes/services.EndpointOAuthModule.html +369 -0
  25. package/docs/classes/services.EndpointOIDCModule.html +369 -0
  26. package/docs/classes/services.EndpointRequestHeadersModule.html +369 -0
  27. package/docs/classes/services.EndpointResponseHeadersModule.html +369 -0
  28. package/docs/classes/services.EndpointSAMLModule.html +369 -0
  29. package/docs/classes/services.EndpointTLSTerminationModule.html +369 -0
  30. package/docs/classes/services.EndpointWebhookValidationModule.html +369 -0
  31. package/docs/classes/services.EventDestinations.html +442 -0
  32. package/docs/classes/services.EventSources.html +448 -0
  33. package/docs/classes/services.EventStreams.html +442 -0
  34. package/docs/classes/services.EventSubscriptions.html +442 -0
  35. package/docs/classes/services.IPPolicies.html +452 -0
  36. package/docs/classes/services.IPPolicyRules.html +450 -0
  37. package/docs/classes/services.IPRestrictions.html +454 -0
  38. package/docs/classes/services.ReservedAddrs.html +483 -0
  39. package/docs/classes/services.ReservedDomains.html +580 -0
  40. package/docs/classes/services.SSHCertificateAuthorities.html +450 -0
  41. package/docs/classes/services.SSHCredentials.html +450 -0
  42. package/docs/classes/services.SSHHostCertificates.html +451 -0
  43. package/docs/classes/services.SSHUserCertificates.html +451 -0
  44. package/docs/classes/services.TLSCertificates.html +453 -0
  45. package/docs/classes/services.TunnelSessions.html +451 -0
  46. package/docs/classes/services.Tunnels.html +322 -0
  47. package/docs/index.html +239 -0
  48. package/docs/interfaces/client.NgrokConfig.html +179 -0
  49. package/docs/interfaces/datatypes.APIKey.html +262 -0
  50. package/docs/interfaces/datatypes.APIKeyCreate.html +186 -0
  51. package/docs/interfaces/datatypes.APIKeyList.html +205 -0
  52. package/docs/interfaces/datatypes.APIKeyUpdate.html +200 -0
  53. package/docs/interfaces/datatypes.AWSAuth.html +186 -0
  54. package/docs/interfaces/datatypes.AWSCredentials.html +186 -0
  55. package/docs/interfaces/datatypes.AWSRole.html +167 -0
  56. package/docs/interfaces/datatypes.AbuseReport.html +281 -0
  57. package/docs/interfaces/datatypes.AbuseReportCreate.html +186 -0
  58. package/docs/interfaces/datatypes.AbuseReportHostname.html +186 -0
  59. package/docs/interfaces/datatypes.AgentIngress.html +300 -0
  60. package/docs/interfaces/datatypes.AgentIngressCreate.html +205 -0
  61. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  62. package/docs/interfaces/datatypes.AgentIngressUpdate.html +200 -0
  63. package/docs/interfaces/datatypes.CertificateAuthority.html +357 -0
  64. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +205 -0
  65. package/docs/interfaces/datatypes.CertificateAuthorityList.html +205 -0
  66. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +200 -0
  67. package/docs/interfaces/datatypes.Credential.html +281 -0
  68. package/docs/interfaces/datatypes.CredentialCreate.html +205 -0
  69. package/docs/interfaces/datatypes.CredentialList.html +205 -0
  70. package/docs/interfaces/datatypes.CredentialUpdate.html +219 -0
  71. package/docs/interfaces/datatypes.Empty.html +130 -0
  72. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +262 -0
  73. package/docs/interfaces/datatypes.EndpointCircuitBreakerReplace.html +176 -0
  74. package/docs/interfaces/datatypes.EndpointCompression.html +167 -0
  75. package/docs/interfaces/datatypes.EndpointCompressionReplace.html +176 -0
  76. package/docs/interfaces/datatypes.EndpointConfiguration.html +490 -0
  77. package/docs/interfaces/datatypes.EndpointConfigurationCreate.html +433 -0
  78. package/docs/interfaces/datatypes.EndpointConfigurationList.html +205 -0
  79. package/docs/interfaces/datatypes.EndpointConfigurationUpdate.html +433 -0
  80. package/docs/interfaces/datatypes.EndpointIPPolicy.html +181 -0
  81. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +186 -0
  82. package/docs/interfaces/datatypes.EndpointIPPolicyReplace.html +176 -0
  83. package/docs/interfaces/datatypes.EndpointLogging.html +186 -0
  84. package/docs/interfaces/datatypes.EndpointLoggingMutate.html +186 -0
  85. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +176 -0
  86. package/docs/interfaces/datatypes.EndpointMutualTLS.html +186 -0
  87. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +186 -0
  88. package/docs/interfaces/datatypes.EndpointMutualTLSReplace.html +176 -0
  89. package/docs/interfaces/datatypes.EndpointOAuth.html +281 -0
  90. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +243 -0
  91. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +281 -0
  92. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +243 -0
  93. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +243 -0
  94. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +224 -0
  95. package/docs/interfaces/datatypes.EndpointOAuthReplace.html +176 -0
  96. package/docs/interfaces/datatypes.EndpointOIDC.html +319 -0
  97. package/docs/interfaces/datatypes.EndpointOIDCReplace.html +176 -0
  98. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +205 -0
  99. package/docs/interfaces/datatypes.EndpointRequestHeadersReplace.html +176 -0
  100. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +205 -0
  101. package/docs/interfaces/datatypes.EndpointResponseHeadersReplace.html +176 -0
  102. package/docs/interfaces/datatypes.EndpointSAML.html +433 -0
  103. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +338 -0
  104. package/docs/interfaces/datatypes.EndpointSAMLReplace.html +176 -0
  105. package/docs/interfaces/datatypes.EndpointTLSTermination.html +205 -0
  106. package/docs/interfaces/datatypes.EndpointTLSTerminationReplace.html +176 -0
  107. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +205 -0
  108. package/docs/interfaces/datatypes.EndpointWebhookValidationReplace.html +176 -0
  109. package/docs/interfaces/datatypes.Error.html +204 -0
  110. package/docs/interfaces/datatypes.EventDestination.html +281 -0
  111. package/docs/interfaces/datatypes.EventDestinationCreate.html +224 -0
  112. package/docs/interfaces/datatypes.EventDestinationList.html +205 -0
  113. package/docs/interfaces/datatypes.EventDestinationUpdate.html +243 -0
  114. package/docs/interfaces/datatypes.EventSource.html +186 -0
  115. package/docs/interfaces/datatypes.EventSourceCreate.html +186 -0
  116. package/docs/interfaces/datatypes.EventSourceItem.html +193 -0
  117. package/docs/interfaces/datatypes.EventSourceList.html +186 -0
  118. package/docs/interfaces/datatypes.EventSourcePaging.html +174 -0
  119. package/docs/interfaces/datatypes.EventSourceReplace.html +167 -0
  120. package/docs/interfaces/datatypes.EventSourceUpdate.html +186 -0
  121. package/docs/interfaces/datatypes.EventStream.html +319 -0
  122. package/docs/interfaces/datatypes.EventStreamCreate.html +262 -0
  123. package/docs/interfaces/datatypes.EventStreamList.html +205 -0
  124. package/docs/interfaces/datatypes.EventStreamUpdate.html +262 -0
  125. package/docs/interfaces/datatypes.EventSubscription.html +281 -0
  126. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +224 -0
  127. package/docs/interfaces/datatypes.EventSubscriptionList.html +205 -0
  128. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +243 -0
  129. package/docs/interfaces/datatypes.EventTarget.html +205 -0
  130. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +186 -0
  131. package/docs/interfaces/datatypes.EventTargetFirehose.html +186 -0
  132. package/docs/interfaces/datatypes.EventTargetKinesis.html +186 -0
  133. package/docs/interfaces/datatypes.IPPolicy.html +262 -0
  134. package/docs/interfaces/datatypes.IPPolicyCreate.html +205 -0
  135. package/docs/interfaces/datatypes.IPPolicyList.html +205 -0
  136. package/docs/interfaces/datatypes.IPPolicyRule.html +281 -0
  137. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +224 -0
  138. package/docs/interfaces/datatypes.IPPolicyRuleList.html +205 -0
  139. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +219 -0
  140. package/docs/interfaces/datatypes.IPPolicyUpdate.html +200 -0
  141. package/docs/interfaces/datatypes.IPRestriction.html +300 -0
  142. package/docs/interfaces/datatypes.IPRestrictionCreate.html +243 -0
  143. package/docs/interfaces/datatypes.IPRestrictionList.html +205 -0
  144. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +238 -0
  145. package/docs/interfaces/datatypes.Item.html +167 -0
  146. package/docs/interfaces/datatypes.Paging.html +176 -0
  147. package/docs/interfaces/datatypes.Ref.html +186 -0
  148. package/docs/interfaces/datatypes.ReservedAddr.html +300 -0
  149. package/docs/interfaces/datatypes.ReservedAddrCreate.html +224 -0
  150. package/docs/interfaces/datatypes.ReservedAddrList.html +205 -0
  151. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +219 -0
  152. package/docs/interfaces/datatypes.ReservedDomain.html +414 -0
  153. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +224 -0
  154. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +186 -0
  155. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +186 -0
  156. package/docs/interfaces/datatypes.ReservedDomainCreate.html +300 -0
  157. package/docs/interfaces/datatypes.ReservedDomainList.html +205 -0
  158. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +276 -0
  159. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +281 -0
  160. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +243 -0
  161. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +205 -0
  162. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +200 -0
  163. package/docs/interfaces/datatypes.SSHCredential.html +281 -0
  164. package/docs/interfaces/datatypes.SSHCredentialCreate.html +224 -0
  165. package/docs/interfaces/datatypes.SSHCredentialList.html +205 -0
  166. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +219 -0
  167. package/docs/interfaces/datatypes.SSHHostCertificate.html +376 -0
  168. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +281 -0
  169. package/docs/interfaces/datatypes.SSHHostCertificateList.html +205 -0
  170. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +200 -0
  171. package/docs/interfaces/datatypes.SSHUserCertificate.html +414 -0
  172. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +319 -0
  173. package/docs/interfaces/datatypes.SSHUserCertificateList.html +205 -0
  174. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +200 -0
  175. package/docs/interfaces/datatypes.TLSCertificate.html +547 -0
  176. package/docs/interfaces/datatypes.TLSCertificateCreate.html +224 -0
  177. package/docs/interfaces/datatypes.TLSCertificateList.html +205 -0
  178. package/docs/interfaces/datatypes.TLSCertificateSANs.html +186 -0
  179. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +200 -0
  180. package/docs/interfaces/datatypes.Tunnel.html +281 -0
  181. package/docs/interfaces/datatypes.TunnelList.html +205 -0
  182. package/docs/interfaces/datatypes.TunnelSession.html +338 -0
  183. package/docs/interfaces/datatypes.TunnelSessionList.html +205 -0
  184. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +162 -0
  185. package/docs/modules/client.html +137 -0
  186. package/docs/modules/datatypes.html +668 -0
  187. package/docs/modules/services.html +260 -0
  188. package/docs/modules.html +119 -0
  189. package/lib/client.d.ts +145 -0
  190. package/lib/client.d.ts.map +1 -0
  191. package/lib/client.js +102 -0
  192. package/lib/client.js.map +1 -0
  193. package/lib/{types.d.ts → datatypes.d.ts} +620 -816
  194. package/lib/datatypes.d.ts.map +1 -0
  195. package/lib/{types.js → datatypes.js} +1 -1
  196. package/lib/datatypes.js.map +1 -0
  197. package/lib/index.d.ts +3 -314
  198. package/lib/index.d.ts.map +1 -0
  199. package/lib/index.js +25 -887
  200. package/lib/index.js.map +1 -1
  201. package/lib/services.d.ts +773 -0
  202. package/lib/services.d.ts.map +1 -0
  203. package/lib/services.js +2761 -0
  204. package/lib/services.js.map +1 -0
  205. package/lib/util.d.ts +5 -0
  206. package/lib/util.d.ts.map +1 -0
  207. package/lib/util.js +53 -0
  208. package/lib/util.js.map +1 -0
  209. package/package.json +12 -3
  210. package/src/client.ts +265 -0
  211. package/src/{types.ts → datatypes.ts} +648 -869
  212. package/src/index.ts +2 -616
  213. package/src/services.ts +2560 -0
  214. package/src/util.ts +48 -0
  215. package/test/apikey.test.js +44 -30
  216. package/test/endpointConfigurations.test.js +38 -34
  217. package/tsconfig.json +17 -7
  218. package/lib/types.js.map +0 -1
package/docs/interfaces/datatypes.ReservedDomain.html ADDED
@@ -0,0 +1,414 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>ReservedDomain | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ReservedDomain.html">ReservedDomain</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface ReservedDomain</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">ReservedDomain</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#acmeChallengeCnameTarget" class="tsd-kind-icon">acme<wbr>Challenge<wbr>Cname<wbr>Target</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#certificate" class="tsd-kind-icon">certificate</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#certificateManagementStatus" class="tsd-kind-icon">certificate<wbr>Management<wbr>Status</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#cnameTarget" class="tsd-kind-icon">cname<wbr>Target</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#description" class="tsd-kind-icon">description</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#domain" class="tsd-kind-icon">domain</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#httpEndpointConfiguration" class="tsd-kind-icon">http<wbr>Endpoint<wbr>Configuration</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#httpsEndpointConfiguration" class="tsd-kind-icon">https<wbr>Endpoint<wbr>Configuration</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#id" class="tsd-kind-icon">id</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#metadata" class="tsd-kind-icon">metadata</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#region" class="tsd-kind-icon">region</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#uri" class="tsd-kind-icon">uri</a></li>
100
+ </ul>
101
+ </section>
102
+ </div>
103
+ </section>
104
+ </section>
105
+ <section class="tsd-panel-group tsd-member-group ">
106
+ <h2>Properties</h2>
107
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
108
+ <a name="acmeChallengeCnameTarget" class="tsd-anchor"></a>
109
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> acme<wbr>Challenge<wbr>Cname<wbr>Target</h3>
110
+ <div class="tsd-signature tsd-kind-icon">acme<wbr>Challenge<wbr>Cname<wbr>Target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111
+ <aside class="tsd-sources">
112
+ <ul>
113
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1179">datatypes.ts:1179</a></li>
114
+ </ul>
115
+ </aside>
116
+ <div class="tsd-comment tsd-typography">
117
+ <div class="lead">
118
+ <p>DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.</p>
119
+ </div>
120
+ </div>
121
+ </section>
122
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
123
+ <a name="certificate" class="tsd-anchor"></a>
124
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate</h3>
125
+ <div class="tsd-signature tsd-kind-icon">certificate<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
126
+ <aside class="tsd-sources">
127
+ <ul>
128
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1173">datatypes.ts:1173</a></li>
129
+ </ul>
130
+ </aside>
131
+ <div class="tsd-comment tsd-typography">
132
+ <div class="lead">
133
+ <p>object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.</p>
134
+ </div>
135
+ </div>
136
+ </section>
137
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
138
+ <a name="certificateManagementPolicy" class="tsd-anchor"></a>
139
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate<wbr>Management<wbr>Policy</h3>
140
+ <div class="tsd-signature tsd-kind-icon">certificate<wbr>Management<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.ReservedDomainCertPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertPolicy</a></div>
141
+ <aside class="tsd-sources">
142
+ <ul>
143
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1175">datatypes.ts:1175</a></li>
144
+ </ul>
145
+ </aside>
146
+ <div class="tsd-comment tsd-typography">
147
+ <div class="lead">
148
+ <p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled</p>
149
+ </div>
150
+ </div>
151
+ </section>
152
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
153
+ <a name="certificateManagementStatus" class="tsd-anchor"></a>
154
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate<wbr>Management<wbr>Status</h3>
155
+ <div class="tsd-signature tsd-kind-icon">certificate<wbr>Management<wbr>Status<span class="tsd-signature-symbol">:</span> <a href="datatypes.ReservedDomainCertStatus.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertStatus</a></div>
156
+ <aside class="tsd-sources">
157
+ <ul>
158
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1177">datatypes.ts:1177</a></li>
159
+ </ul>
160
+ </aside>
161
+ <div class="tsd-comment tsd-typography">
162
+ <div class="lead">
163
+ <p>status of the automatic certificate management for this domain, or null if automatic management is disabled</p>
164
+ </div>
165
+ </div>
166
+ </section>
167
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
168
+ <a name="cnameTarget" class="tsd-anchor"></a>
169
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> cname<wbr>Target</h3>
170
+ <div class="tsd-signature tsd-kind-icon">cname<wbr>Target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
171
+ <aside class="tsd-sources">
172
+ <ul>
173
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1167">datatypes.ts:1167</a></li>
174
+ </ul>
175
+ </aside>
176
+ <div class="tsd-comment tsd-typography">
177
+ <div class="lead">
178
+ <p>DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io</p>
179
+ </div>
180
+ </div>
181
+ </section>
182
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
183
+ <a name="createdAt" class="tsd-anchor"></a>
184
+ <h3>created<wbr>At</h3>
185
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
186
+ <aside class="tsd-sources">
187
+ <ul>
188
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1157">datatypes.ts:1157</a></li>
189
+ </ul>
190
+ </aside>
191
+ <div class="tsd-comment tsd-typography">
192
+ <div class="lead">
193
+ <p>timestamp when the reserved domain was created, RFC 3339 format</p>
194
+ </div>
195
+ </div>
196
+ </section>
197
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
198
+ <a name="description" class="tsd-anchor"></a>
199
+ <h3>description</h3>
200
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
201
+ <aside class="tsd-sources">
202
+ <ul>
203
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1159">datatypes.ts:1159</a></li>
204
+ </ul>
205
+ </aside>
206
+ <div class="tsd-comment tsd-typography">
207
+ <div class="lead">
208
+ <p>human-readable description of what this reserved domain will be used for</p>
209
+ </div>
210
+ </div>
211
+ </section>
212
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
213
+ <a name="domain" class="tsd-anchor"></a>
214
+ <h3>domain</h3>
215
+ <div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
216
+ <aside class="tsd-sources">
217
+ <ul>
218
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1163">datatypes.ts:1163</a></li>
219
+ </ul>
220
+ </aside>
221
+ <div class="tsd-comment tsd-typography">
222
+ <div class="lead">
223
+ <p>hostname of the reserved domain</p>
224
+ </div>
225
+ </div>
226
+ </section>
227
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
228
+ <a name="httpEndpointConfiguration" class="tsd-anchor"></a>
229
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> http<wbr>Endpoint<wbr>Configuration</h3>
230
+ <div class="tsd-signature tsd-kind-icon">http<wbr>Endpoint<wbr>Configuration<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
231
+ <aside class="tsd-sources">
232
+ <ul>
233
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1169">datatypes.ts:1169</a></li>
234
+ </ul>
235
+ </aside>
236
+ <div class="tsd-comment tsd-typography">
237
+ <div class="lead">
238
+ <p>object referencing the endpoint configuration applied to http traffic on this domain</p>
239
+ </div>
240
+ </div>
241
+ </section>
242
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
243
+ <a name="httpsEndpointConfiguration" class="tsd-anchor"></a>
244
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> https<wbr>Endpoint<wbr>Configuration</h3>
245
+ <div class="tsd-signature tsd-kind-icon">https<wbr>Endpoint<wbr>Configuration<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
246
+ <aside class="tsd-sources">
247
+ <ul>
248
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1171">datatypes.ts:1171</a></li>
249
+ </ul>
250
+ </aside>
251
+ <div class="tsd-comment tsd-typography">
252
+ <div class="lead">
253
+ <p>object referencing the endpoint configuration applied to https traffic on this domain</p>
254
+ </div>
255
+ </div>
256
+ </section>
257
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
258
+ <a name="id" class="tsd-anchor"></a>
259
+ <h3>id</h3>
260
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
261
+ <aside class="tsd-sources">
262
+ <ul>
263
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1153">datatypes.ts:1153</a></li>
264
+ </ul>
265
+ </aside>
266
+ <div class="tsd-comment tsd-typography">
267
+ <div class="lead">
268
+ <p>unique reserved domain resource identifier</p>
269
+ </div>
270
+ </div>
271
+ </section>
272
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
273
+ <a name="metadata" class="tsd-anchor"></a>
274
+ <h3>metadata</h3>
275
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
276
+ <aside class="tsd-sources">
277
+ <ul>
278
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1161">datatypes.ts:1161</a></li>
279
+ </ul>
280
+ </aside>
281
+ <div class="tsd-comment tsd-typography">
282
+ <div class="lead">
283
+ <p>arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p>
284
+ </div>
285
+ </div>
286
+ </section>
287
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
288
+ <a name="region" class="tsd-anchor"></a>
289
+ <h3>region</h3>
290
+ <div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
291
+ <aside class="tsd-sources">
292
+ <ul>
293
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1165">datatypes.ts:1165</a></li>
294
+ </ul>
295
+ </aside>
296
+ <div class="tsd-comment tsd-typography">
297
+ <div class="lead">
298
+ <p>reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</p>
299
+ </div>
300
+ </div>
301
+ </section>
302
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
303
+ <a name="uri" class="tsd-anchor"></a>
304
+ <h3>uri</h3>
305
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
306
+ <aside class="tsd-sources">
307
+ <ul>
308
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1155">datatypes.ts:1155</a></li>
309
+ </ul>
310
+ </aside>
311
+ <div class="tsd-comment tsd-typography">
312
+ <div class="lead">
313
+ <p>URI of the reserved domain API resource</p>
314
+ </div>
315
+ </div>
316
+ </section>
317
+ </section>
318
+ </div>
319
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
320
+ <nav class="tsd-navigation primary">
321
+ <ul>
322
+ <li class=" ">
323
+ <a href="../modules.html">Modules</a>
324
+ </li>
325
+ <li class=" tsd-kind-module">
326
+ <a href="../modules/client.html">client</a>
327
+ </li>
328
+ <li class="current tsd-kind-module">
329
+ <a href="../modules/datatypes.html">datatypes</a>
330
+ </li>
331
+ <li class=" tsd-kind-module">
332
+ <a href="../modules/services.html">services</a>
333
+ </li>
334
+ </ul>
335
+ </nav>
336
+ <nav class="tsd-navigation secondary menu-sticky">
337
+ <ul class="before-current">
338
+ </ul>
339
+ <ul class="current">
340
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
341
+ <a href="datatypes.ReservedDomain.html" class="tsd-kind-icon">Reserved<wbr>Domain</a>
342
+ <ul>
343
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
344
+ <a href="datatypes.ReservedDomain.html#acmeChallengeCnameTarget" class="tsd-kind-icon">acme<wbr>Challenge<wbr>Cname<wbr>Target</a>
345
+ </li>
346
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
347
+ <a href="datatypes.ReservedDomain.html#certificate" class="tsd-kind-icon">certificate</a>
348
+ </li>
349
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
350
+ <a href="datatypes.ReservedDomain.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a>
351
+ </li>
352
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
353
+ <a href="datatypes.ReservedDomain.html#certificateManagementStatus" class="tsd-kind-icon">certificate<wbr>Management<wbr>Status</a>
354
+ </li>
355
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
356
+ <a href="datatypes.ReservedDomain.html#cnameTarget" class="tsd-kind-icon">cname<wbr>Target</a>
357
+ </li>
358
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
359
+ <a href="datatypes.ReservedDomain.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
360
+ </li>
361
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
362
+ <a href="datatypes.ReservedDomain.html#description" class="tsd-kind-icon">description</a>
363
+ </li>
364
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
365
+ <a href="datatypes.ReservedDomain.html#domain" class="tsd-kind-icon">domain</a>
366
+ </li>
367
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
368
+ <a href="datatypes.ReservedDomain.html#httpEndpointConfiguration" class="tsd-kind-icon">http<wbr>Endpoint<wbr>Configuration</a>
369
+ </li>
370
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
371
+ <a href="datatypes.ReservedDomain.html#httpsEndpointConfiguration" class="tsd-kind-icon">https<wbr>Endpoint<wbr>Configuration</a>
372
+ </li>
373
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
374
+ <a href="datatypes.ReservedDomain.html#id" class="tsd-kind-icon">id</a>
375
+ </li>
376
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
377
+ <a href="datatypes.ReservedDomain.html#metadata" class="tsd-kind-icon">metadata</a>
378
+ </li>
379
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
380
+ <a href="datatypes.ReservedDomain.html#region" class="tsd-kind-icon">region</a>
381
+ </li>
382
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
383
+ <a href="datatypes.ReservedDomain.html#uri" class="tsd-kind-icon">uri</a>
384
+ </li>
385
+ </ul>
386
+ </li>
387
+ </ul>
388
+ <ul class="after-current">
389
+ </ul>
390
+ </nav>
391
+ </div>
392
+ </div>
393
+ </div>
394
+ <footer class="with-border-bottom">
395
+ <div class="container">
396
+ <h2>Legend</h2>
397
+ <div class="tsd-legend-group">
398
+ <ul class="tsd-legend">
399
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
400
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
401
+ </ul>
402
+ <ul class="tsd-legend">
403
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
404
+ </ul>
405
+ </div>
406
+ </div>
407
+ </footer>
408
+ <div class="container tsd-generator">
409
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
410
+ </div>
411
+ <div class="overlay"></div>
412
+ <script src="../assets/js/main.js"></script>
413
+ </body>
414
+ </html>
package/docs/interfaces/datatypes.ReservedDomainCertJob.html ADDED
@@ -0,0 +1,224 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>ReservedDomainCertJob | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ReservedDomainCertJob.html">ReservedDomainCertJob</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface ReservedDomainCertJob</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">ReservedDomainCertJob</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertJob.html#errorCode" class="tsd-kind-icon">error<wbr>Code</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertJob.html#msg" class="tsd-kind-icon">msg</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertJob.html#retriesAt" class="tsd-kind-icon">retries<wbr>At</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertJob.html#startedAt" class="tsd-kind-icon">started<wbr>At</a></li>
90
+ </ul>
91
+ </section>
92
+ </div>
93
+ </section>
94
+ </section>
95
+ <section class="tsd-panel-group tsd-member-group ">
96
+ <h2>Properties</h2>
97
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
98
+ <a name="errorCode" class="tsd-anchor"></a>
99
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> error<wbr>Code</h3>
100
+ <div class="tsd-signature tsd-kind-icon">error<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101
+ <aside class="tsd-sources">
102
+ <ul>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1207">datatypes.ts:1207</a></li>
104
+ </ul>
105
+ </aside>
106
+ <div class="tsd-comment tsd-typography">
107
+ <div class="lead">
108
+ <p>if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).</p>
109
+ </div>
110
+ </div>
111
+ </section>
112
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
+ <a name="msg" class="tsd-anchor"></a>
114
+ <h3>msg</h3>
115
+ <div class="tsd-signature tsd-kind-icon">msg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
+ <aside class="tsd-sources">
117
+ <ul>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1209">datatypes.ts:1209</a></li>
119
+ </ul>
120
+ </aside>
121
+ <div class="tsd-comment tsd-typography">
122
+ <div class="lead">
123
+ <p>a message describing the current status or error</p>
124
+ </div>
125
+ </div>
126
+ </section>
127
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
128
+ <a name="retriesAt" class="tsd-anchor"></a>
129
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> retries<wbr>At</h3>
130
+ <div class="tsd-signature tsd-kind-icon">retries<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
+ <aside class="tsd-sources">
132
+ <ul>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1213">datatypes.ts:1213</a></li>
134
+ </ul>
135
+ </aside>
136
+ <div class="tsd-comment tsd-typography">
137
+ <div class="lead">
138
+ <p>timestamp when the provisioning job will be retried</p>
139
+ </div>
140
+ </div>
141
+ </section>
142
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
143
+ <a name="startedAt" class="tsd-anchor"></a>
144
+ <h3>started<wbr>At</h3>
145
+ <div class="tsd-signature tsd-kind-icon">started<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
146
+ <aside class="tsd-sources">
147
+ <ul>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1211">datatypes.ts:1211</a></li>
149
+ </ul>
150
+ </aside>
151
+ <div class="tsd-comment tsd-typography">
152
+ <div class="lead">
153
+ <p>timestamp when the provisioning job started, RFC 3339 format</p>
154
+ </div>
155
+ </div>
156
+ </section>
157
+ </section>
158
+ </div>
159
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
160
+ <nav class="tsd-navigation primary">
161
+ <ul>
162
+ <li class=" ">
163
+ <a href="../modules.html">Modules</a>
164
+ </li>
165
+ <li class=" tsd-kind-module">
166
+ <a href="../modules/client.html">client</a>
167
+ </li>
168
+ <li class="current tsd-kind-module">
169
+ <a href="../modules/datatypes.html">datatypes</a>
170
+ </li>
171
+ <li class=" tsd-kind-module">
172
+ <a href="../modules/services.html">services</a>
173
+ </li>
174
+ </ul>
175
+ </nav>
176
+ <nav class="tsd-navigation secondary menu-sticky">
177
+ <ul class="before-current">
178
+ </ul>
179
+ <ul class="current">
180
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
181
+ <a href="datatypes.ReservedDomainCertJob.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Job</a>
182
+ <ul>
183
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
184
+ <a href="datatypes.ReservedDomainCertJob.html#errorCode" class="tsd-kind-icon">error<wbr>Code</a>
185
+ </li>
186
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
187
+ <a href="datatypes.ReservedDomainCertJob.html#msg" class="tsd-kind-icon">msg</a>
188
+ </li>
189
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
190
+ <a href="datatypes.ReservedDomainCertJob.html#retriesAt" class="tsd-kind-icon">retries<wbr>At</a>
191
+ </li>
192
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
193
+ <a href="datatypes.ReservedDomainCertJob.html#startedAt" class="tsd-kind-icon">started<wbr>At</a>
194
+ </li>
195
+ </ul>
196
+ </li>
197
+ </ul>
198
+ <ul class="after-current">
199
+ </ul>
200
+ </nav>
201
+ </div>
202
+ </div>
203
+ </div>
204
+ <footer class="with-border-bottom">
205
+ <div class="container">
206
+ <h2>Legend</h2>
207
+ <div class="tsd-legend-group">
208
+ <ul class="tsd-legend">
209
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
210
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
211
+ </ul>
212
+ <ul class="tsd-legend">
213
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
214
+ </ul>
215
+ </div>
216
+ </div>
217
+ </footer>
218
+ <div class="container tsd-generator">
219
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
220
+ </div>
221
+ <div class="overlay"></div>
222
+ <script src="../assets/js/main.js"></script>
223
+ </body>
224
+ </html>