@ngrok/ngrok-api 0.2.0 → 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 (190) hide show
  1. package/docs/CNAME +1 -0
  2. package/docs/assets/js/search.js +1 -1
  3. package/docs/classes/client.Ngrok.html +37 -43
  4. package/docs/classes/services.APIKeys.html +9 -9
  5. package/docs/classes/services.AbuseReports.html +6 -6
  6. package/docs/classes/{services.IPWhitelist.html → services.AgentIngresses.html} +61 -69
  7. package/docs/classes/services.CertificateAuthorities.html +9 -9
  8. package/docs/classes/services.Credentials.html +9 -9
  9. package/docs/classes/services.EndpointCircuitBreakerModule.html +7 -7
  10. package/docs/classes/services.EndpointCompressionModule.html +7 -7
  11. package/docs/classes/services.EndpointConfigurations.html +9 -9
  12. package/docs/classes/services.EndpointIPPolicyModule.html +7 -7
  13. package/docs/classes/services.EndpointLoggingModule.html +7 -7
  14. package/docs/classes/services.EndpointMutualTLSModule.html +7 -7
  15. package/docs/classes/services.EndpointOAuthModule.html +7 -7
  16. package/docs/classes/services.EndpointOIDCModule.html +7 -7
  17. package/docs/classes/services.EndpointRequestHeadersModule.html +7 -7
  18. package/docs/classes/services.EndpointResponseHeadersModule.html +7 -7
  19. package/docs/classes/services.EndpointSAMLModule.html +7 -7
  20. package/docs/classes/services.EndpointTLSTerminationModule.html +7 -7
  21. package/docs/classes/services.EndpointWebhookValidationModule.html +7 -7
  22. package/docs/classes/services.EventDestinations.html +9 -9
  23. package/docs/classes/services.EventSources.html +9 -9
  24. package/docs/classes/services.EventStreams.html +9 -9
  25. package/docs/classes/services.EventSubscriptions.html +9 -9
  26. package/docs/classes/services.IPPolicies.html +9 -9
  27. package/docs/classes/services.IPPolicyRules.html +9 -9
  28. package/docs/classes/services.IPRestrictions.html +9 -9
  29. package/docs/classes/services.ReservedAddrs.html +10 -10
  30. package/docs/classes/services.ReservedDomains.html +13 -13
  31. package/docs/classes/services.SSHCertificateAuthorities.html +9 -9
  32. package/docs/classes/services.SSHCredentials.html +9 -9
  33. package/docs/classes/services.SSHHostCertificates.html +9 -9
  34. package/docs/classes/services.SSHUserCertificates.html +9 -9
  35. package/docs/classes/services.TLSCertificates.html +9 -9
  36. package/docs/classes/services.TunnelSessions.html +9 -9
  37. package/docs/classes/services.Tunnels.html +5 -5
  38. package/docs/interfaces/client.NgrokConfig.html +2 -2
  39. package/docs/interfaces/datatypes.APIKey.html +6 -6
  40. package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
  41. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  42. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  43. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  44. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  45. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  46. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  47. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  48. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  49. package/docs/interfaces/{datatypes.IPWhitelistEntry.html → datatypes.AgentIngress.html} +73 -35
  50. package/docs/interfaces/{datatypes.IPWhitelistEntryCreate.html → datatypes.AgentIngressCreate.html} +20 -20
  51. package/docs/interfaces/{datatypes.IPWhitelistEntryList.html → datatypes.AgentIngressList.html} +26 -26
  52. package/docs/interfaces/{datatypes.IPWhitelistEntryUpdate.html → datatypes.AgentIngressUpdate.html} +16 -16
  53. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  54. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  55. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  56. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  57. package/docs/interfaces/datatypes.Credential.html +7 -7
  58. package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
  59. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  60. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  61. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  62. package/docs/interfaces/datatypes.EndpointCircuitBreakerReplace.html +2 -2
  63. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  64. package/docs/interfaces/datatypes.EndpointCompressionReplace.html +2 -2
  65. package/docs/interfaces/datatypes.EndpointConfiguration.html +18 -18
  66. package/docs/interfaces/datatypes.EndpointConfigurationCreate.html +15 -15
  67. package/docs/interfaces/datatypes.EndpointConfigurationList.html +3 -3
  68. package/docs/interfaces/datatypes.EndpointConfigurationUpdate.html +15 -15
  69. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  70. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  71. package/docs/interfaces/datatypes.EndpointIPPolicyReplace.html +2 -2
  72. package/docs/interfaces/datatypes.EndpointLogging.html +2 -2
  73. package/docs/interfaces/datatypes.EndpointLoggingMutate.html +2 -2
  74. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +2 -2
  75. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  76. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  77. package/docs/interfaces/datatypes.EndpointMutualTLSReplace.html +2 -2
  78. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  79. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  80. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  81. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  82. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  83. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
  84. package/docs/interfaces/datatypes.EndpointOAuthReplace.html +2 -2
  85. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  86. package/docs/interfaces/datatypes.EndpointOIDCReplace.html +2 -2
  87. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  88. package/docs/interfaces/datatypes.EndpointRequestHeadersReplace.html +2 -2
  89. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  90. package/docs/interfaces/datatypes.EndpointResponseHeadersReplace.html +2 -2
  91. package/docs/interfaces/datatypes.EndpointSAML.html +33 -14
  92. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +28 -9
  93. package/docs/interfaces/datatypes.EndpointSAMLReplace.html +2 -2
  94. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  95. package/docs/interfaces/datatypes.EndpointTLSTerminationReplace.html +2 -2
  96. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  97. package/docs/interfaces/datatypes.EndpointWebhookValidationReplace.html +2 -2
  98. package/docs/interfaces/datatypes.Error.html +4 -4
  99. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  100. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  101. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  102. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  103. package/docs/interfaces/datatypes.EventSource.html +2 -2
  104. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  105. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  106. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  107. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  108. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  109. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  110. package/docs/interfaces/datatypes.EventStream.html +9 -9
  111. package/docs/interfaces/datatypes.EventStreamCreate.html +6 -6
  112. package/docs/interfaces/datatypes.EventStreamList.html +3 -3
  113. package/docs/interfaces/datatypes.EventStreamUpdate.html +6 -6
  114. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  115. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
  116. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  117. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  118. package/docs/interfaces/datatypes.EventTarget.html +3 -3
  119. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  120. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  121. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  122. package/docs/interfaces/datatypes.IPPolicy.html +6 -6
  123. package/docs/interfaces/datatypes.IPPolicyCreate.html +3 -3
  124. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  125. package/docs/interfaces/datatypes.IPPolicyRule.html +7 -7
  126. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +4 -4
  127. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  128. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  129. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  130. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  131. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  132. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  133. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  134. package/docs/interfaces/datatypes.Item.html +1 -1
  135. package/docs/interfaces/datatypes.Paging.html +2 -2
  136. package/docs/interfaces/datatypes.Ref.html +2 -2
  137. package/docs/interfaces/datatypes.ReservedAddr.html +8 -8
  138. package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
  139. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  140. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +4 -4
  141. package/docs/interfaces/datatypes.ReservedDomain.html +32 -13
  142. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -23
  143. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  144. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  145. package/docs/interfaces/datatypes.ReservedDomainCreate.html +8 -8
  146. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  147. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +7 -7
  148. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  149. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  150. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  151. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  152. package/docs/interfaces/datatypes.SSHCredential.html +7 -7
  153. package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
  154. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  155. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  156. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  157. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  158. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  159. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  160. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  161. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  162. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  163. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  164. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  165. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  166. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  167. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  168. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  169. package/docs/interfaces/datatypes.Tunnel.html +7 -7
  170. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  171. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  172. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  173. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  174. package/docs/modules/datatypes.html +16 -20
  175. package/docs/modules/services.html +4 -4
  176. package/lib/client.d.ts +1 -5
  177. package/lib/client.d.ts.map +1 -1
  178. package/lib/client.js +3 -4
  179. package/lib/client.js.map +1 -1
  180. package/lib/datatypes.d.ts +49 -47
  181. package/lib/datatypes.d.ts.map +1 -1
  182. package/lib/services.d.ts +27 -31
  183. package/lib/services.d.ts.map +1 -1
  184. package/lib/services.js +155 -159
  185. package/lib/services.js.map +1 -1
  186. package/package.json +1 -1
  187. package/src/client.ts +3 -7
  188. package/src/datatypes.ts +53 -52
  189. package/src/services.ts +98 -102
  190. package/docs/interfaces/datatypes.ReservedDomainCertNSTarget.html +0 -186
@@ -103,7 +103,7 @@
103
103
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
104
104
  <aside class="tsd-sources">
105
105
  <ul>
106
- <li>Defined in datatypes.ts:1557</li>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1558">datatypes.ts:1558</a></li>
107
107
  </ul>
108
108
  </aside>
109
109
  <div class="tsd-comment tsd-typography">
@@ -118,7 +118,7 @@
118
118
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
119
119
  <aside class="tsd-sources">
120
120
  <ul>
121
- <li>Defined in datatypes.ts:1563</li>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1564">datatypes.ts:1564</a></li>
122
122
  </ul>
123
123
  </aside>
124
124
  <div class="tsd-comment tsd-typography">
@@ -133,7 +133,7 @@
133
133
  <div class="tsd-signature tsd-kind-icon">proto<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134
134
  <aside class="tsd-sources">
135
135
  <ul>
136
- <li>Defined in datatypes.ts:1565</li>
136
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1566">datatypes.ts:1566</a></li>
137
137
  </ul>
138
138
  </aside>
139
139
  <div class="tsd-comment tsd-typography">
@@ -148,7 +148,7 @@
148
148
  <div class="tsd-signature tsd-kind-icon">public<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149
149
  <aside class="tsd-sources">
150
150
  <ul>
151
- <li>Defined in datatypes.ts:1559</li>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1560">datatypes.ts:1560</a></li>
152
152
  </ul>
153
153
  </aside>
154
154
  <div class="tsd-comment tsd-typography">
@@ -163,7 +163,7 @@
163
163
  <div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
164
164
  <aside class="tsd-sources">
165
165
  <ul>
166
- <li>Defined in datatypes.ts:1567</li>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1568">datatypes.ts:1568</a></li>
167
167
  </ul>
168
168
  </aside>
169
169
  <div class="tsd-comment tsd-typography">
@@ -178,7 +178,7 @@
178
178
  <div class="tsd-signature tsd-kind-icon">started<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
179
179
  <aside class="tsd-sources">
180
180
  <ul>
181
- <li>Defined in datatypes.ts:1561</li>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1562">datatypes.ts:1562</a></li>
182
182
  </ul>
183
183
  </aside>
184
184
  <div class="tsd-comment tsd-typography">
@@ -193,7 +193,7 @@
193
193
  <div class="tsd-signature tsd-kind-icon">tunnel<wbr>Session<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
194
194
  <aside class="tsd-sources">
195
195
  <ul>
196
- <li>Defined in datatypes.ts:1569</li>
196
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1570">datatypes.ts:1570</a></li>
197
197
  </ul>
198
198
  </aside>
199
199
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in datatypes.ts:1578</li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1579">datatypes.ts:1579</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
114
114
  <div class="tsd-signature tsd-kind-icon">tunnels<span class="tsd-signature-symbol">:</span> <a href="datatypes.Tunnel.html" class="tsd-signature-type" data-tsd-kind="Interface">Tunnel</a><span class="tsd-signature-symbol">[]</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in datatypes.ts:1574</li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1575">datatypes.ts:1575</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  <div class="tsd-comment tsd-typography">
@@ -129,7 +129,7 @@
129
129
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
130
  <aside class="tsd-sources">
131
131
  <ul>
132
- <li>Defined in datatypes.ts:1576</li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1577">datatypes.ts:1577</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -106,7 +106,7 @@
106
106
  <div class="tsd-signature tsd-kind-icon">agent<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
107
107
  <aside class="tsd-sources">
108
108
  <ul>
109
- <li>Defined in datatypes.ts:1521</li>
109
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1522">datatypes.ts:1522</a></li>
110
110
  </ul>
111
111
  </aside>
112
112
  <div class="tsd-comment tsd-typography">
@@ -121,7 +121,7 @@
121
121
  <div class="tsd-signature tsd-kind-icon">credential<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
122
122
  <aside class="tsd-sources">
123
123
  <ul>
124
- <li>Defined in datatypes.ts:1523</li>
124
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1524">datatypes.ts:1524</a></li>
125
125
  </ul>
126
126
  </aside>
127
127
  <div class="tsd-comment tsd-typography">
@@ -136,7 +136,7 @@
136
136
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
137
137
  <aside class="tsd-sources">
138
138
  <ul>
139
- <li>Defined in datatypes.ts:1525</li>
139
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1526">datatypes.ts:1526</a></li>
140
140
  </ul>
141
141
  </aside>
142
142
  <div class="tsd-comment tsd-typography">
@@ -151,7 +151,7 @@
151
151
  <div class="tsd-signature tsd-kind-icon">ip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
152
152
  <aside class="tsd-sources">
153
153
  <ul>
154
- <li>Defined in datatypes.ts:1527</li>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1528">datatypes.ts:1528</a></li>
155
155
  </ul>
156
156
  </aside>
157
157
  <div class="tsd-comment tsd-typography">
@@ -166,7 +166,7 @@
166
166
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
167
167
  <aside class="tsd-sources">
168
168
  <ul>
169
- <li>Defined in datatypes.ts:1529</li>
169
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1530">datatypes.ts:1530</a></li>
170
170
  </ul>
171
171
  </aside>
172
172
  <div class="tsd-comment tsd-typography">
@@ -181,7 +181,7 @@
181
181
  <div class="tsd-signature tsd-kind-icon">os<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
182
182
  <aside class="tsd-sources">
183
183
  <ul>
184
- <li>Defined in datatypes.ts:1531</li>
184
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1532">datatypes.ts:1532</a></li>
185
185
  </ul>
186
186
  </aside>
187
187
  <div class="tsd-comment tsd-typography">
@@ -196,7 +196,7 @@
196
196
  <div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
197
197
  <aside class="tsd-sources">
198
198
  <ul>
199
- <li>Defined in datatypes.ts:1533</li>
199
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1534">datatypes.ts:1534</a></li>
200
200
  </ul>
201
201
  </aside>
202
202
  <div class="tsd-comment tsd-typography">
@@ -211,7 +211,7 @@
211
211
  <div class="tsd-signature tsd-kind-icon">started<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
212
212
  <aside class="tsd-sources">
213
213
  <ul>
214
- <li>Defined in datatypes.ts:1535</li>
214
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1536">datatypes.ts:1536</a></li>
215
215
  </ul>
216
216
  </aside>
217
217
  <div class="tsd-comment tsd-typography">
@@ -226,7 +226,7 @@
226
226
  <div class="tsd-signature tsd-kind-icon">transport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
227
227
  <aside class="tsd-sources">
228
228
  <ul>
229
- <li>Defined in datatypes.ts:1537</li>
229
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1538">datatypes.ts:1538</a></li>
230
230
  </ul>
231
231
  </aside>
232
232
  <div class="tsd-comment tsd-typography">
@@ -241,7 +241,7 @@
241
241
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
242
242
  <aside class="tsd-sources">
243
243
  <ul>
244
- <li>Defined in datatypes.ts:1539</li>
244
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1540">datatypes.ts:1540</a></li>
245
245
  </ul>
246
246
  </aside>
247
247
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in datatypes.ts:1548</li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1549">datatypes.ts:1549</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
114
114
  <div class="tsd-signature tsd-kind-icon">tunnel<wbr>Sessions<span class="tsd-signature-symbol">:</span> <a href="datatypes.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">[]</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in datatypes.ts:1544</li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1545">datatypes.ts:1545</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  <div class="tsd-comment tsd-typography">
@@ -129,7 +129,7 @@
129
129
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
130
  <aside class="tsd-sources">
131
131
  <ul>
132
- <li>Defined in datatypes.ts:1546</li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1547">datatypes.ts:1547</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -97,7 +97,7 @@
97
97
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
98
98
  <aside class="tsd-sources">
99
99
  <ul>
100
- <li>Defined in datatypes.ts:1552</li>
100
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1553">datatypes.ts:1553</a></li>
101
101
  </ul>
102
102
  </aside>
103
103
  </section>
@@ -82,6 +82,10 @@
82
82
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.AbuseReport.html" class="tsd-kind-icon">Abuse<wbr>Report</a></li>
83
83
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.AbuseReportCreate.html" class="tsd-kind-icon">Abuse<wbr>Report<wbr>Create</a></li>
84
84
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.AbuseReportHostname.html" class="tsd-kind-icon">Abuse<wbr>Report<wbr>Hostname</a></li>
85
+ <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-kind-icon">Agent<wbr>Ingress</a></li>
86
+ <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.AgentIngressCreate.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>Create</a></li>
87
+ <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.AgentIngressList.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>List</a></li>
88
+ <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.AgentIngressUpdate.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>Update</a></li>
85
89
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.CertificateAuthority.html" class="tsd-kind-icon">Certificate<wbr>Authority</a></li>
86
90
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.CertificateAuthorityCreate.html" class="tsd-kind-icon">Certificate<wbr>Authority<wbr>Create</a></li>
87
91
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.CertificateAuthorityList.html" class="tsd-kind-icon">Certificate<wbr>Authority<wbr>List</a></li>
@@ -164,10 +168,6 @@
164
168
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.IPRestrictionCreate.html" class="tsd-kind-icon">IPRestriction<wbr>Create</a></li>
165
169
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.IPRestrictionList.html" class="tsd-kind-icon">IPRestriction<wbr>List</a></li>
166
170
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.IPRestrictionUpdate.html" class="tsd-kind-icon">IPRestriction<wbr>Update</a></li>
167
- <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.IPWhitelistEntry.html" class="tsd-kind-icon">IPWhitelist<wbr>Entry</a></li>
168
- <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.IPWhitelistEntryCreate.html" class="tsd-kind-icon">IPWhitelist<wbr>Entry<wbr>Create</a></li>
169
- <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.IPWhitelistEntryList.html" class="tsd-kind-icon">IPWhitelist<wbr>Entry<wbr>List</a></li>
170
- <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.IPWhitelistEntryUpdate.html" class="tsd-kind-icon">IPWhitelist<wbr>Entry<wbr>Update</a></li>
171
171
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.Item.html" class="tsd-kind-icon">Item</a></li>
172
172
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.Paging.html" class="tsd-kind-icon">Paging</a></li>
173
173
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.Ref.html" class="tsd-kind-icon">Ref</a></li>
@@ -177,7 +177,6 @@
177
177
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.ReservedAddrUpdate.html" class="tsd-kind-icon">Reserved<wbr>Addr<wbr>Update</a></li>
178
178
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.ReservedDomain.html" class="tsd-kind-icon">Reserved<wbr>Domain</a></li>
179
179
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.ReservedDomainCertJob.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Job</a></li>
180
- <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.ReservedDomainCertNSTarget.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>CertNSTarget</a></li>
181
180
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.ReservedDomainCertPolicy.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Policy</a></li>
182
181
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.ReservedDomainCertStatus.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Status</a></li>
183
182
  <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/datatypes.ReservedDomainCreate.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Create</a></li>
@@ -264,6 +263,18 @@
264
263
  <li class=" tsd-kind-interface tsd-parent-kind-module">
265
264
  <a href="../interfaces/datatypes.AbuseReportHostname.html" class="tsd-kind-icon">Abuse<wbr>Report<wbr>Hostname</a>
266
265
  </li>
266
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
267
+ <a href="../interfaces/datatypes.AgentIngress.html" class="tsd-kind-icon">Agent<wbr>Ingress</a>
268
+ </li>
269
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
270
+ <a href="../interfaces/datatypes.AgentIngressCreate.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>Create</a>
271
+ </li>
272
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
273
+ <a href="../interfaces/datatypes.AgentIngressList.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>List</a>
274
+ </li>
275
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
276
+ <a href="../interfaces/datatypes.AgentIngressUpdate.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>Update</a>
277
+ </li>
267
278
  <li class=" tsd-kind-interface tsd-parent-kind-module">
268
279
  <a href="../interfaces/datatypes.CertificateAuthority.html" class="tsd-kind-icon">Certificate<wbr>Authority</a>
269
280
  </li>
@@ -510,18 +521,6 @@
510
521
  <li class=" tsd-kind-interface tsd-parent-kind-module">
511
522
  <a href="../interfaces/datatypes.IPRestrictionUpdate.html" class="tsd-kind-icon">IPRestriction<wbr>Update</a>
512
523
  </li>
513
- <li class=" tsd-kind-interface tsd-parent-kind-module">
514
- <a href="../interfaces/datatypes.IPWhitelistEntry.html" class="tsd-kind-icon">IPWhitelist<wbr>Entry</a>
515
- </li>
516
- <li class=" tsd-kind-interface tsd-parent-kind-module">
517
- <a href="../interfaces/datatypes.IPWhitelistEntryCreate.html" class="tsd-kind-icon">IPWhitelist<wbr>Entry<wbr>Create</a>
518
- </li>
519
- <li class=" tsd-kind-interface tsd-parent-kind-module">
520
- <a href="../interfaces/datatypes.IPWhitelistEntryList.html" class="tsd-kind-icon">IPWhitelist<wbr>Entry<wbr>List</a>
521
- </li>
522
- <li class=" tsd-kind-interface tsd-parent-kind-module">
523
- <a href="../interfaces/datatypes.IPWhitelistEntryUpdate.html" class="tsd-kind-icon">IPWhitelist<wbr>Entry<wbr>Update</a>
524
- </li>
525
524
  <li class=" tsd-kind-interface tsd-parent-kind-module">
526
525
  <a href="../interfaces/datatypes.Item.html" class="tsd-kind-icon">Item</a>
527
526
  </li>
@@ -549,9 +548,6 @@
549
548
  <li class=" tsd-kind-interface tsd-parent-kind-module">
550
549
  <a href="../interfaces/datatypes.ReservedDomainCertJob.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Job</a>
551
550
  </li>
552
- <li class=" tsd-kind-interface tsd-parent-kind-module">
553
- <a href="../interfaces/datatypes.ReservedDomainCertNSTarget.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>CertNSTarget</a>
554
- </li>
555
551
  <li class=" tsd-kind-interface tsd-parent-kind-module">
556
552
  <a href="../interfaces/datatypes.ReservedDomainCertPolicy.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Policy</a>
557
553
  </li>
@@ -74,6 +74,7 @@
74
74
  <ul class="tsd-index-list">
75
75
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.APIKeys.html" class="tsd-kind-icon">APIKeys</a></li>
76
76
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a></li>
77
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a></li>
77
78
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a></li>
78
79
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.Credentials.html" class="tsd-kind-icon">Credentials</a></li>
79
80
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a></li>
@@ -96,7 +97,6 @@
96
97
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a></li>
97
98
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a></li>
98
99
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a></li>
99
- <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.IPWhitelist.html" class="tsd-kind-icon">IPWhitelist</a></li>
100
100
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a></li>
101
101
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a></li>
102
102
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a></li>
@@ -137,6 +137,9 @@
137
137
  <li class=" tsd-kind-class tsd-parent-kind-module">
138
138
  <a href="../classes/services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
139
139
  </li>
140
+ <li class=" tsd-kind-class tsd-parent-kind-module">
141
+ <a href="../classes/services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a>
142
+ </li>
140
143
  <li class=" tsd-kind-class tsd-parent-kind-module">
141
144
  <a href="../classes/services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
142
145
  </li>
@@ -203,9 +206,6 @@
203
206
  <li class=" tsd-kind-class tsd-parent-kind-module">
204
207
  <a href="../classes/services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
205
208
  </li>
206
- <li class=" tsd-kind-class tsd-parent-kind-module">
207
- <a href="../classes/services.IPWhitelist.html" class="tsd-kind-icon">IPWhitelist</a>
208
- </li>
209
209
  <li class=" tsd-kind-class tsd-parent-kind-module">
210
210
  <a href="../classes/services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
211
211
  </li>
package/lib/client.d.ts CHANGED
@@ -12,6 +12,7 @@ export declare class Ngrok {
12
12
  ngrok that violate ngrok's terms of service.
13
13
  */
14
14
  abuseReports: services.AbuseReports;
15
+ agentIngresses: services.AgentIngresses;
15
16
  /**
16
17
  * API Keys are used to authenticate to the [ngrok
17
18
  API](https://ngrok.com/docs/api#authentication). You may use the API itself
@@ -66,11 +67,6 @@ export declare class Ngrok {
66
67
  public-facing endpoints.
67
68
  */
68
69
  ipRestrictions: services.IPRestrictions;
69
- /**
70
- * The IP Whitelist is deprecated and will be removed. Use an IP Restriction
71
- with an `endpoints` type instead.
72
- */
73
- ipWhitelist: services.IPWhitelist;
74
70
  /**
75
71
  * Reserved Addresses are TCP addresses that can be used to listen for traffic.
76
72
  TCP address hostnames and ports are assigned by ngrok, they cannot be
@@ -1 +1 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAQvC,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,KAAK;IAChB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAW;IAC7B;;;OAGG;IACI,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IAC3C;;;;;;OAMG;IACI,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IACjC;;;;;;OAMG;IACI,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;IAC/D;;;;;OAKG;IACI,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC;IACzC;;;;OAIG;IACI,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;IACxD,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IACpC,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAC9C,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC;IAChD,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IAC3C;;;;;OAKG;IACI,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IACvC;;;OAGG;IACI,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC7C;;;;;;;OAOG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;OAGG;IACI,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC;IACzC;;;;OAIG;IACI,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC7C;;;;;OAKG;IACI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;IACjD;;;OAGG;IACI,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB,CAAC;IACrE;;;OAGG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;OAIG;IACI,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IACzD;;;;OAIG;IACI,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IACzD;;;;;;OAMG;IACI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;IACjD;;;;OAIG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;OAGG;IACI,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IAC1B,cAAc,EAAE;QACrB,qBAAqB,EAAE,QAAQ,CAAC,qBAAqB,CAAA;QACrD,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAA;QACnE,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB,CAAA;QAC7D,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAA;QACnE,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAA;QACvD,uBAAuB,EAAE,QAAQ,CAAC,uBAAuB,CAAA;QACzD,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAA;QACnE,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B,CAAA;QACrE,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAA;QACjD,+BAA+B,EAAE,QAAQ,CAAC,+BAA+B,CAAA;QACzE,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAA;QAC/C,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAA;KAChD,CAAC;IAEF;;;;OAIG;gBACgB,EAAC,OAAiC,EAAE,QAAQ,EAAC,EAAE,WAAW;CA8E9E"}
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAQvC,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,KAAK;IAChB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAW;IAC7B;;;OAGG;IACI,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IACpC,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;;;OAMG;IACI,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IACjC;;;;;;OAMG;IACI,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;IAC/D;;;;;OAKG;IACI,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC;IACzC;;;;OAIG;IACI,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;IACxD,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IACpC,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAC9C,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC;IAChD,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IAC3C;;;;;OAKG;IACI,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IACvC;;;OAGG;IACI,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC7C;;;;;;;OAOG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;OAIG;IACI,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC7C;;;;;OAKG;IACI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;IACjD;;;OAGG;IACI,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB,CAAC;IACrE;;;OAGG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;OAIG;IACI,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IACzD;;;;OAIG;IACI,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IACzD;;;;;;OAMG;IACI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;IACjD;;;;OAIG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;OAGG;IACI,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IAC1B,cAAc,EAAE;QACrB,qBAAqB,EAAE,QAAQ,CAAC,qBAAqB,CAAA;QACrD,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAA;QACnE,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB,CAAA;QAC7D,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAA;QACnE,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAA;QACvD,uBAAuB,EAAE,QAAQ,CAAC,uBAAuB,CAAA;QACzD,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAA;QACnE,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B,CAAA;QACrE,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAA;QACjD,+BAA+B,EAAE,QAAQ,CAAC,+BAA+B,CAAA;QACzE,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAA;QAC/C,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAA;KAChD,CAAC;IAEF;;;;OAIG;gBACgB,EAAC,OAAiC,EAAE,QAAQ,EAAC,EAAE,WAAW;CA8E9E"}
package/lib/client.js CHANGED
@@ -7,7 +7,7 @@ const formData = require('form-data');
7
7
  const url_1 = require('url');
8
8
  const node_fetch_1 = require('node-fetch');
9
9
  const services = require('./services');
10
- wretch_1.default().polyfills({
10
+ (0, wretch_1.default)().polyfills({
11
11
  fetch: node_fetch_1.default,
12
12
  FormData: formData,
13
13
  URLSearchParams: url_1.URLSearchParams,
@@ -25,8 +25,7 @@ class Ngrok {
25
25
  } else {
26
26
  throw new Error('Cannot create ngrok client without an API token');
27
27
  }
28
- this.httpClient = wretch_1
29
- .default()
28
+ this.httpClient = (0, wretch_1.default)()
30
29
  .url(baseUrl)
31
30
  .headers({
32
31
  'User-Agent': 'ngrok-ts-user-agent',
@@ -35,6 +34,7 @@ class Ngrok {
35
34
  .content('application/json')
36
35
  .auth('Bearer ' + this.token);
37
36
  this.abuseReports = new services.AbuseReports(this.httpClient);
37
+ this.agentIngresses = new services.AgentIngresses(this.httpClient);
38
38
  this.apiKeys = new services.APIKeys(this.httpClient);
39
39
  this.certificateAuthorities = new services.CertificateAuthorities(
40
40
  this.httpClient
@@ -50,7 +50,6 @@ class Ngrok {
50
50
  this.ipPolicies = new services.IPPolicies(this.httpClient);
51
51
  this.ipPolicyRules = new services.IPPolicyRules(this.httpClient);
52
52
  this.ipRestrictions = new services.IPRestrictions(this.httpClient);
53
- this.ipWhitelist = new services.IPWhitelist(this.httpClient);
54
53
  this.reservedAddrs = new services.ReservedAddrs(this.httpClient);
55
54
  this.reservedDomains = new services.ReservedDomains(this.httpClient);
56
55
  this.sshCertificateAuthorities = new services.SSHCertificateAuthorities(
package/lib/client.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,mCAA0C;AAC1C,sCAAsC;AACtC,6BAAsC;AACtC,2CAAmC;AACnC,uCAAuC;AAEvC,gBAAM,EAAE,CAAC,SAAS,CAAC;IACf,KAAK,EAAE,oBAAS;IAChB,QAAQ,EAAE,QAAQ;IAClB,eAAe,EAAf,qBAAe;CAClB,CAAC,CAAC;AAOH,MAAa,KAAK;IAyIhB;;;;OAIG;IACH,YAAmB,EAAC,OAAO,GAAG,uBAAuB,EAAE,QAAQ,EAAc;QAC3E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;SACvB;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QAED,IAAI,CAAC,UAAU,GAAG,gBAAM,EAAE;aACvB,GAAG,CAAC,OAAO,CAAC;aACZ,OAAO,CAAC;YACP,YAAY,EAAE,qBAAqB;YACnC,eAAe,EAAE,GAAG;SACrB,CAAC;aACD,OAAO,CAAC,kBAAkB,CAAC;aAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAG9B,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErD,IAAI,CAAC,sBAAsB,GAAG,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnF,IAAI,CAAC,WAAW,GAAG,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7D,IAAI,CAAC,sBAAsB,GAAG,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnF,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,iBAAiB,GAAG,IAAI,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEzE,IAAI,CAAC,kBAAkB,GAAG,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE3E,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,UAAU,GAAG,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE3D,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjE,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,WAAW,GAAG,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7D,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjE,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErE,IAAI,CAAC,yBAAyB,GAAG,IAAI,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEzF,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7E,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7E,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErE,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG;YAC3B,qBAAqB,EAAE,IAAI,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1E,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,yBAAyB,EAAE,IAAI,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,UAAU,CAAC;YAClF,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,sBAAsB,EAAE,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5E,uBAAuB,EAAE,IAAI,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC9E,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,6BAA6B,EAAE,IAAI,QAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1F,mBAAmB,EAAE,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACtE,+BAA+B,EAAE,IAAI,QAAQ,CAAC,+BAA+B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC9F,kBAAkB,EAAE,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;YACpE,kBAAkB,EAAE,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;SAC9D,CAAC;IACN,CAAC;CACF;AA5ND,sBA4NC"}
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,mCAA0C;AAC1C,sCAAsC;AACtC,6BAAsC;AACtC,2CAAmC;AACnC,uCAAuC;AAEvC,IAAA,gBAAM,GAAE,CAAC,SAAS,CAAC;IACf,KAAK,EAAE,oBAAS;IAChB,QAAQ,EAAE,QAAQ;IAClB,eAAe,EAAf,qBAAe;CAClB,CAAC,CAAC;AAOH,MAAa,KAAK;IAqIhB;;;;OAIG;IACH,YAAmB,EAAC,OAAO,GAAG,uBAAuB,EAAE,QAAQ,EAAc;QAC3E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;SACvB;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QAED,IAAI,CAAC,UAAU,GAAG,IAAA,gBAAM,GAAE;aACvB,GAAG,CAAC,OAAO,CAAC;aACZ,OAAO,CAAC;YACP,YAAY,EAAE,qBAAqB;YACnC,eAAe,EAAE,GAAG;SACrB,CAAC;aACD,OAAO,CAAC,kBAAkB,CAAC;aAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAG9B,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErD,IAAI,CAAC,sBAAsB,GAAG,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnF,IAAI,CAAC,WAAW,GAAG,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7D,IAAI,CAAC,sBAAsB,GAAG,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnF,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,iBAAiB,GAAG,IAAI,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEzE,IAAI,CAAC,kBAAkB,GAAG,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE3E,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,UAAU,GAAG,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE3D,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjE,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjE,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErE,IAAI,CAAC,yBAAyB,GAAG,IAAI,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEzF,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7E,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7E,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErE,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG;YAC3B,qBAAqB,EAAE,IAAI,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1E,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,yBAAyB,EAAE,IAAI,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,UAAU,CAAC;YAClF,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,sBAAsB,EAAE,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5E,uBAAuB,EAAE,IAAI,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC9E,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,6BAA6B,EAAE,IAAI,QAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1F,mBAAmB,EAAE,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACtE,+BAA+B,EAAE,IAAI,QAAQ,CAAC,+BAA+B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC9F,kBAAkB,EAAE,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;YACpE,kBAAkB,EAAE,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;SAC9D,CAAC;IACN,CAAC;CACF;AAxND,sBAwNC"}
@@ -48,6 +48,47 @@ export interface AbuseReportCreate {
48
48
  /** arbitrary user-defined data about this abuse report. Optional, max 4096 bytes. */
49
49
  metadata: string;
50
50
  }
51
+ export interface AgentIngressCreate {
52
+ /** human-readable description of the use of this Agent Ingress. optional, max 255 bytes. */
53
+ description: string;
54
+ /** arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes */
55
+ metadata: string;
56
+ /** the domain that you own to be used as the base domain name to generate regional agent ingress domains. */
57
+ domain: string;
58
+ }
59
+ export interface AgentIngressUpdate {
60
+ id: string;
61
+ /** human-readable description of the use of this Agent Ingress. optional, max 255 bytes. */
62
+ description?: string;
63
+ /** arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes */
64
+ metadata?: string;
65
+ }
66
+ export interface AgentIngress {
67
+ /** unique Agent Ingress resource identifier */
68
+ id: string;
69
+ /** URI to the API resource of this Agent ingress */
70
+ uri: string;
71
+ /** human-readable description of the use of this Agent Ingress. optional, max 255 bytes. */
72
+ description: string;
73
+ /** arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes */
74
+ metadata: string;
75
+ /** the domain that you own to be used as the base domain name to generate regional agent ingress domains. */
76
+ domain: string;
77
+ /** a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok */
78
+ nsTargets: Array<string>;
79
+ /** a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions */
80
+ regionDomains: Array<string>;
81
+ /** timestamp when the Agent Ingress was created, RFC 3339 format */
82
+ createdAt: string;
83
+ }
84
+ export interface AgentIngressList {
85
+ /** the list of Agent Ingresses owned by this account */
86
+ ingresses: Array<AgentIngress>;
87
+ /** URI of the Agent Ingress list API resource */
88
+ uri: string;
89
+ /** URI of the next page, or null if there is no next page */
90
+ nextPageUri?: string;
91
+ }
51
92
  export interface APIKeyCreate {
52
93
  /** human-readable description of what uses the API key to authenticate. optional, max 255 bytes. */
53
94
  description: string;
@@ -284,7 +325,7 @@ export interface EndpointConfigurationCreate {
284
325
  export interface EndpointWebhookValidation {
285
326
  /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
286
327
  enabled?: boolean;
287
- /** a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: `SLACK`, `SNS`, `STRIPE`, `GITHUB`, `TWILIO`, `SHOPIFY`, `GITLAB`, `INTERCOM`. */
328
+ /** a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: `SLACK`, `SNS`, `STRIPE`, `GITHUB`, `TWILIO`, `SHOPIFY`, `GITLAB`, `INTERCOM`, `SENDGRID`, `XERO`. */
288
329
  provider: string;
289
330
  /** a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret */
290
331
  secret: string;
@@ -473,6 +514,8 @@ export interface EndpointSAML {
473
514
  requestSigningCertificatePem: string;
474
515
  /** A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata. */
475
516
  metadataUrl: string;
517
+ /** Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent` will be used. A subset of the allowed values enumerated by the SAML specification are supported. */
518
+ nameidFormat: string;
476
519
  }
477
520
  export interface EndpointSAMLMutate {
478
521
  /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
@@ -493,6 +536,8 @@ export interface EndpointSAMLMutate {
493
536
  allowIdpInitiated?: boolean;
494
537
  /** If present, only users who are a member of one of the listed groups may access the target endpoint. */
495
538
  authorizedGroups: Array<string>;
539
+ /** Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent` will be used. A subset of the allowed values enumerated by the SAML specification are supported. */
540
+ nameidFormat: string;
496
541
  }
497
542
  export interface EndpointOIDC {
498
543
  /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
@@ -873,43 +918,6 @@ export interface IPRestrictionList {
873
918
  /** URI of the next page, or null if there is no next page */
874
919
  nextPageUri?: string;
875
920
  }
876
- export interface IPWhitelistEntryCreate {
877
- /** human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes. */
878
- description: string;
879
- /** arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes. */
880
- metadata: string;
881
- /** 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 */
882
- ipNet: string;
883
- }
884
- export interface IPWhitelistEntryUpdate {
885
- id: string;
886
- /** human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes. */
887
- description?: string;
888
- /** arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes. */
889
- metadata?: string;
890
- }
891
- export interface IPWhitelistEntry {
892
- /** unique identifier for this IP whitelist entry */
893
- id: string;
894
- /** URI of the IP whitelist entry API resource */
895
- uri: string;
896
- /** timestamp when the IP whitelist entry was created, RFC 3339 format */
897
- createdAt: string;
898
- /** human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes. */
899
- description: string;
900
- /** arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes. */
901
- metadata: string;
902
- /** 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 */
903
- ipNet: string;
904
- }
905
- export interface IPWhitelistEntryList {
906
- /** the list of all IP whitelist entries on this account */
907
- whitelist: Array<IPWhitelistEntry>;
908
- /** URI of the IP whitelist API resource */
909
- uri: string;
910
- /** URI of the next page, or null if there is no next page */
911
- nextPageUri?: string;
912
- }
913
921
  export interface EndpointLoggingReplace {
914
922
  id: string;
915
923
  module: EndpointLoggingMutate;
@@ -966,7 +974,7 @@ export interface ReservedAddrCreate {
966
974
  /** reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) */
967
975
  region: string;
968
976
  /** ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address */
969
- endpointConfigurationId: string;
977
+ endpointConfigurationId?: string;
970
978
  }
971
979
  export interface ReservedAddrUpdate {
972
980
  id: string;
@@ -1063,6 +1071,8 @@ export interface ReservedDomain {
1063
1071
  certificateManagementPolicy?: ReservedDomainCertPolicy;
1064
1072
  /** status of the automatic certificate management for this domain, or null if automatic management is disabled */
1065
1073
  certificateManagementStatus?: ReservedDomainCertStatus;
1074
+ /** 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. */
1075
+ acmeChallengeCnameTarget?: string;
1066
1076
  }
1067
1077
  export interface ReservedDomainList {
1068
1078
  /** the list of all reserved domains on this account */
@@ -1084,12 +1094,6 @@ export interface ReservedDomainCertStatus {
1084
1094
  /** status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed */
1085
1095
  provisioningJob?: ReservedDomainCertJob;
1086
1096
  }
1087
- export interface ReservedDomainCertNSTarget {
1088
- /** the zone that the nameservers need to be applied to */
1089
- zone: string;
1090
- /** the nameservers the user must add */
1091
- nameservers: Array<string>;
1092
- }
1093
1097
  export interface ReservedDomainCertJob {
1094
1098
  /** 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). */
1095
1099
  errorCode?: string;
@@ -1099,8 +1103,6 @@ export interface ReservedDomainCertJob {
1099
1103
  startedAt: string;
1100
1104
  /** timestamp when the provisioning job will be retried */
1101
1105
  retriesAt?: string;
1102
- /** if present, indicates the dns nameservers that the user must configure to complete the provisioning process of a wildcard certificate */
1103
- nsTargets: Array<ReservedDomainCertNSTarget>;
1104
1106
  }
1105
1107
  export interface SSHCertificateAuthorityCreate {
1106
1108
  /** human-readable description of this SSH Certificate Authority. optional, max 255 bytes. */