@ngrok/ngrok-api 0.8.0 → 0.10.0

package/.eslintignore

@@ -1,2 +1,4 @@
+# Code generated for API Clients. DO NOT EDIT.
+
 node_modules/
 *.d.ts

package/.eslintrc.js

@@ -1,3 +1,5 @@
+// Code generated for API Clients. DO NOT EDIT.
+
 module.exports = {
     "env": {
         "browser": true,

package/.prettierrc.js

@@ -1,3 +1,5 @@
+// Code generated for API Clients. DO NOT EDIT.
+
 module.exports = {
   trailingComma: "es5",
   tabWidth: 2,

package/CHANGELOG.md

@@ -1,4 +1,13 @@
-## 0.2.0 (July 14, 2021)
+<!-- Code generated for API Clients. DO NOT EDIT. -->
+
+## 0.3.0
+
+ENHANCEMENTS:
+
+* Added `owner_id` field to the `api_key`, `credential`, and `ssh_credential` resources. If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
+* Added `failover_backend`, `http_response_backend`, and `tunnel_group_backend` resources. A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.
+
+## 0.2.0
 
 ENHANCEMENTS:
 
@@ -14,14 +23,14 @@ FIXES:
 * Use Markdown instead of plain text for Typedoc
 * Use Promise when a method returns no result instead of an empty object
 
-## 0.1.0 (June 18, 2021)
+## 0.1.0
 
 ENHANCEMENTS:
 
 * List iterators supporting automatic paging
 * Generate TypeScript documentation
 
-## 0.0.11 (June 8, 2021)
+## 0.0.11
 
 FIXES:
 

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,45 @@
+# ngrok Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+The ngrok documentation team is responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+The ngrok documentation team has the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the ngrok docs project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [support@ngrok.com](mailto:support@ngrok.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

package/README.md

@@ -1,9 +1,18 @@
-## ngrok API client library for JavaScript and TypeScript
+<!-- Code generated for API Clients. DO NOT EDIT. -->
+
+# Unstable
+
+This library is currently unstable. We know of rough edges
+and are working to bring it to parity with our other API client
+libraries. Please feel free to try it out and let us know if you find
+it useful!
+
+# ngrok API client library for JavaScript and TypeScript
 
 This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
 easier to consume in JavaScript or TypeScript.
 
-### Installation
+## Installation
 
 The published library is available on
 [npm](https://www.npmjs.com/package/@ngrok/ngrok-api).
@@ -12,7 +21,11 @@ The published library is available on
 npm install @ngrok/ngrok-api
 ```
 
-### Documentation
+## Support
+
+The best place to get support using this library is through the [ngrok Slack Community](https://ngrok.com/slack). If you find any bugs, please contribute by opening a [new GitHub issue](https://github.com/ngrok/ngrok-api-typescript/issues/new/choose).
+
+## Documentation
 
 A quickstart guide and a full API reference are included in the [ngrok
 TypeScript API documentation](https://typescript-api.docs.ngrok.com)
@@ -29,12 +42,12 @@ key. API resources can be accessed as properties of the `Ngrok` object.
 import { Ngrok } from '@ngrok/ngrok-api';
 
 const ngrok = new Ngrok({
-    apiToken: '<API KEY>',
+  apiToken: '<API KEY>',
 });
 
 const domain = await ngrok.domains.create({
-  name: 'your-name.ngrok.io'
-})
+  name: 'your-name.ngrok.io',
+});
 console.log(domain);
 ```
 
@@ -49,7 +62,7 @@ API for you behind the scenes.
 import { Ngrok } from '@ngrok/ngrok-api';
 
 const ngrok = new Ngrok({
-    apiToken: '<API KEY>',
+  apiToken: '<API KEY>',
 });
 
 (await ngrok.tunnels.list()).forEach(t => console.log(t));
@@ -61,16 +74,15 @@ All API methods return a `Promise` and are suitable for use in asynchronous
 programming. You can use callback chaining with `.then()` and `.catch()` syntax
 or the `await` keyword to wait for completion of an API call.
 
-
 ```typescript
 // await style
-const cred = await ngrok.credentials.create({description: "example"});
+const cred = await ngrok.credentials.create({ description: 'example' });
 console.log(cred);
 
 // callback chaining
-ngrok.credentials.create({description: "example"}).then((cred => {
-    console.log(cred)
-}));
+ngrok.credentials.create({ description: 'example' }).then(cred => {
+  console.log(cred);
+});
 ```
 
 ### Error Handling
@@ -84,17 +96,16 @@ The `Error` type includes a `statusCode` property which can be used to
 distinguish not found errors when a resource does not exist:
 
 ```typescript
-
 import { Error } from '@ngrok/ngrok-api';
 
 try {
   await ngrok.ipPolicies.update({
     id: 'someInvalidId',
     description: 'updated description',
-  })
+  });
 } catch (err: Error) {
   if (err.statusCode == 404) {
-    console.log('no ip policy with that id to update')
+    console.log('no ip policy with that id to update');
   }
 }
 ```
@@ -110,12 +121,12 @@ import { Error } from '@ngrok/ngrok-api';
 try {
   await ngrok.ipPolicies.create({
     action: 'something invalid',
-  })
+  });
 } catch (err: Error) {
-  if (err.errorCode == "ERR_NGROK_1410") {
-    console.log('not a valid ip policy action')
+  if (err.errorCode == 'ERR_NGROK_1410') {
+    console.log('not a valid ip policy action');
   } else {
-    console.log('some other error', err)
+    console.log('some other error', err);
   }
 }
 ```