@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.IPPolicyUpdate.html ADDED
@@ -0,0 +1,200 @@
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>IPPolicyUpdate | @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.IPPolicyUpdate.html">IPPolicyUpdate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface IPPolicyUpdate</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">IPPolicyUpdate</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.IPPolicyUpdate.html#description" class="tsd-kind-icon">description</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyUpdate.html#id" class="tsd-kind-icon">id</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
+ </ul>
90
+ </section>
91
+ </div>
92
+ </section>
93
+ </section>
94
+ <section class="tsd-panel-group tsd-member-group ">
95
+ <h2>Properties</h2>
96
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
97
+ <a name="description" class="tsd-anchor"></a>
98
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
99
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
+ <aside class="tsd-sources">
101
+ <ul>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L878">datatypes.ts:878</a></li>
103
+ </ul>
104
+ </aside>
105
+ <div class="tsd-comment tsd-typography">
106
+ <div class="lead">
107
+ <p>human-readable description of the source IPs of this IP policy. optional, max 255 bytes.</p>
108
+ </div>
109
+ </div>
110
+ </section>
111
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
+ <a name="id" class="tsd-anchor"></a>
113
+ <h3>id</h3>
114
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
+ <aside class="tsd-sources">
116
+ <ul>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L876">datatypes.ts:876</a></li>
118
+ </ul>
119
+ </aside>
120
+ </section>
121
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
122
+ <a name="metadata" class="tsd-anchor"></a>
123
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
124
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
125
+ <aside class="tsd-sources">
126
+ <ul>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L880">datatypes.ts:880</a></li>
128
+ </ul>
129
+ </aside>
130
+ <div class="tsd-comment tsd-typography">
131
+ <div class="lead">
132
+ <p>arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.</p>
133
+ </div>
134
+ </div>
135
+ </section>
136
+ </section>
137
+ </div>
138
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
139
+ <nav class="tsd-navigation primary">
140
+ <ul>
141
+ <li class=" ">
142
+ <a href="../modules.html">Modules</a>
143
+ </li>
144
+ <li class=" tsd-kind-module">
145
+ <a href="../modules/client.html">client</a>
146
+ </li>
147
+ <li class="current tsd-kind-module">
148
+ <a href="../modules/datatypes.html">datatypes</a>
149
+ </li>
150
+ <li class=" tsd-kind-module">
151
+ <a href="../modules/services.html">services</a>
152
+ </li>
153
+ </ul>
154
+ </nav>
155
+ <nav class="tsd-navigation secondary menu-sticky">
156
+ <ul class="before-current">
157
+ </ul>
158
+ <ul class="current">
159
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
160
+ <a href="datatypes.IPPolicyUpdate.html" class="tsd-kind-icon">IPPolicy<wbr>Update</a>
161
+ <ul>
162
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
163
+ <a href="datatypes.IPPolicyUpdate.html#description" class="tsd-kind-icon">description</a>
164
+ </li>
165
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
166
+ <a href="datatypes.IPPolicyUpdate.html#id" class="tsd-kind-icon">id</a>
167
+ </li>
168
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
169
+ <a href="datatypes.IPPolicyUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
170
+ </li>
171
+ </ul>
172
+ </li>
173
+ </ul>
174
+ <ul class="after-current">
175
+ </ul>
176
+ </nav>
177
+ </div>
178
+ </div>
179
+ </div>
180
+ <footer class="with-border-bottom">
181
+ <div class="container">
182
+ <h2>Legend</h2>
183
+ <div class="tsd-legend-group">
184
+ <ul class="tsd-legend">
185
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
186
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
187
+ </ul>
188
+ <ul class="tsd-legend">
189
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
190
+ </ul>
191
+ </div>
192
+ </div>
193
+ </footer>
194
+ <div class="container tsd-generator">
195
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
196
+ </div>
197
+ <div class="overlay"></div>
198
+ <script src="../assets/js/main.js"></script>
199
+ </body>
200
+ </html>
package/docs/interfaces/datatypes.IPRestriction.html ADDED
@@ -0,0 +1,300 @@
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>IPRestriction | @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.IPRestriction.html">IPRestriction</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface IPRestriction</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">IPRestriction</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.IPRestriction.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#enforced" class="tsd-kind-icon">enforced</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#metadata" class="tsd-kind-icon">metadata</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#type" class="tsd-kind-icon">type</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#uri" class="tsd-kind-icon">uri</a></li>
94
+ </ul>
95
+ </section>
96
+ </div>
97
+ </section>
98
+ </section>
99
+ <section class="tsd-panel-group tsd-member-group ">
100
+ <h2>Properties</h2>
101
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
102
+ <a name="createdAt" class="tsd-anchor"></a>
103
+ <h3>created<wbr>At</h3>
104
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
105
+ <aside class="tsd-sources">
106
+ <ul>
107
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L985">datatypes.ts:985</a></li>
108
+ </ul>
109
+ </aside>
110
+ <div class="tsd-comment tsd-typography">
111
+ <div class="lead">
112
+ <p>timestamp when the IP restriction was created, RFC 3339 format</p>
113
+ </div>
114
+ </div>
115
+ </section>
116
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
117
+ <a name="description" class="tsd-anchor"></a>
118
+ <h3>description</h3>
119
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
120
+ <aside class="tsd-sources">
121
+ <ul>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L987">datatypes.ts:987</a></li>
123
+ </ul>
124
+ </aside>
125
+ <div class="tsd-comment tsd-typography">
126
+ <div class="lead">
127
+ <p>human-readable description of this IP restriction. optional, max 255 bytes.</p>
128
+ </div>
129
+ </div>
130
+ </section>
131
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
132
+ <a name="enforced" class="tsd-anchor"></a>
133
+ <h3>enforced</h3>
134
+ <div class="tsd-signature tsd-kind-icon">enforced<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
135
+ <aside class="tsd-sources">
136
+ <ul>
137
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L991">datatypes.ts:991</a></li>
138
+ </ul>
139
+ </aside>
140
+ <div class="tsd-comment tsd-typography">
141
+ <div class="lead">
142
+ <p>true if the IP restriction will be enforced. if false, only warnings will be issued</p>
143
+ </div>
144
+ </div>
145
+ </section>
146
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
147
+ <a name="id" class="tsd-anchor"></a>
148
+ <h3>id</h3>
149
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
150
+ <aside class="tsd-sources">
151
+ <ul>
152
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L981">datatypes.ts:981</a></li>
153
+ </ul>
154
+ </aside>
155
+ <div class="tsd-comment tsd-typography">
156
+ <div class="lead">
157
+ <p>unique identifier for this IP restriction</p>
158
+ </div>
159
+ </div>
160
+ </section>
161
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
162
+ <a name="ipPolicies" class="tsd-anchor"></a>
163
+ <h3>ip<wbr>Policies</h3>
164
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
165
+ <aside class="tsd-sources">
166
+ <ul>
167
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L995">datatypes.ts:995</a></li>
168
+ </ul>
169
+ </aside>
170
+ <div class="tsd-comment tsd-typography">
171
+ <div class="lead">
172
+ <p>the set of IP policies that are used to enforce the restriction</p>
173
+ </div>
174
+ </div>
175
+ </section>
176
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
177
+ <a name="metadata" class="tsd-anchor"></a>
178
+ <h3>metadata</h3>
179
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
180
+ <aside class="tsd-sources">
181
+ <ul>
182
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L989">datatypes.ts:989</a></li>
183
+ </ul>
184
+ </aside>
185
+ <div class="tsd-comment tsd-typography">
186
+ <div class="lead">
187
+ <p>arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.</p>
188
+ </div>
189
+ </div>
190
+ </section>
191
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
192
+ <a name="type" class="tsd-anchor"></a>
193
+ <h3>type</h3>
194
+ <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
195
+ <aside class="tsd-sources">
196
+ <ul>
197
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L993">datatypes.ts:993</a></li>
198
+ </ul>
199
+ </aside>
200
+ <div class="tsd-comment tsd-typography">
201
+ <div class="lead">
202
+ <p>the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: <code>dashboard</code>, <code>api</code>, <code>agent</code>, and <code>endpoints</code></p>
203
+ </div>
204
+ </div>
205
+ </section>
206
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
207
+ <a name="uri" class="tsd-anchor"></a>
208
+ <h3>uri</h3>
209
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
210
+ <aside class="tsd-sources">
211
+ <ul>
212
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L983">datatypes.ts:983</a></li>
213
+ </ul>
214
+ </aside>
215
+ <div class="tsd-comment tsd-typography">
216
+ <div class="lead">
217
+ <p>URI of the IP restriction API resource</p>
218
+ </div>
219
+ </div>
220
+ </section>
221
+ </section>
222
+ </div>
223
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
224
+ <nav class="tsd-navigation primary">
225
+ <ul>
226
+ <li class=" ">
227
+ <a href="../modules.html">Modules</a>
228
+ </li>
229
+ <li class=" tsd-kind-module">
230
+ <a href="../modules/client.html">client</a>
231
+ </li>
232
+ <li class="current tsd-kind-module">
233
+ <a href="../modules/datatypes.html">datatypes</a>
234
+ </li>
235
+ <li class=" tsd-kind-module">
236
+ <a href="../modules/services.html">services</a>
237
+ </li>
238
+ </ul>
239
+ </nav>
240
+ <nav class="tsd-navigation secondary menu-sticky">
241
+ <ul class="before-current">
242
+ </ul>
243
+ <ul class="current">
244
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
245
+ <a href="datatypes.IPRestriction.html" class="tsd-kind-icon">IPRestriction</a>
246
+ <ul>
247
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
248
+ <a href="datatypes.IPRestriction.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
249
+ </li>
250
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
251
+ <a href="datatypes.IPRestriction.html#description" class="tsd-kind-icon">description</a>
252
+ </li>
253
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
254
+ <a href="datatypes.IPRestriction.html#enforced" class="tsd-kind-icon">enforced</a>
255
+ </li>
256
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
257
+ <a href="datatypes.IPRestriction.html#id" class="tsd-kind-icon">id</a>
258
+ </li>
259
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
260
+ <a href="datatypes.IPRestriction.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a>
261
+ </li>
262
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
263
+ <a href="datatypes.IPRestriction.html#metadata" class="tsd-kind-icon">metadata</a>
264
+ </li>
265
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
266
+ <a href="datatypes.IPRestriction.html#type" class="tsd-kind-icon">type</a>
267
+ </li>
268
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
269
+ <a href="datatypes.IPRestriction.html#uri" class="tsd-kind-icon">uri</a>
270
+ </li>
271
+ </ul>
272
+ </li>
273
+ </ul>
274
+ <ul class="after-current">
275
+ </ul>
276
+ </nav>
277
+ </div>
278
+ </div>
279
+ </div>
280
+ <footer class="with-border-bottom">
281
+ <div class="container">
282
+ <h2>Legend</h2>
283
+ <div class="tsd-legend-group">
284
+ <ul class="tsd-legend">
285
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
286
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
287
+ </ul>
288
+ <ul class="tsd-legend">
289
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
290
+ </ul>
291
+ </div>
292
+ </div>
293
+ </footer>
294
+ <div class="container tsd-generator">
295
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
296
+ </div>
297
+ <div class="overlay"></div>
298
+ <script src="../assets/js/main.js"></script>
299
+ </body>
300
+ </html>