Skip to content

Commit

Permalink
running precommit hooks on all md files
Browse files Browse the repository at this point in the history
  • Loading branch information
@paigen11
paigen11 committed Mar 15, 2023
1 parent adaba90 commit fa16d1a
Show file tree
Hide file tree
Showing 62 changed files with 657 additions and 931 deletions.
38 changes: 18 additions & 20 deletions src/docs/AuthorizationApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,40 @@

All URIs are relative to *https://api.notefile.net*

Method | HTTP request | Description
------------- | ------------- | -------------
[**login**](AuthorizationApi.md#login) | **POST** /auth/login |


| Method | HTTP request | Description |
| -------------------------------------- | -------------------- | ----------- |
| [**login**](AuthorizationApi.md#login) | **POST** /auth/login |

## login

> Login200Response login(loginRequest)


Gets a session token from the API from a username and password.

### Example

```javascript
import * as NotehubJs from '@blues-inc/notehub-js';
import * as NotehubJs from "@blues-inc/notehub-js";

let apiInstance = new NotehubJs.AuthorizationApi();
let loginRequest = {"username":"[email protected]","password":"test-password"}; // LoginRequest |
apiInstance.login(loginRequest).then((data) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, (error) => {
console.error(error);
});

let loginRequest = { username: "[email protected]", password: "test-password" }; // LoginRequest |
apiInstance.login(loginRequest).then(
(data) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
},
(error) => {
console.error(error);
}
);
```

### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**loginRequest** | [**LoginRequest**](LoginRequest.md)| |
| Name | Type | Description | Notes |
| ---------------- | ----------------------------------- | ----------- | ----- |
| **loginRequest** | [**LoginRequest**](LoginRequest.md) | |

### Return type

Expand All @@ -50,4 +49,3 @@ No authorization required

- **Content-Type**: application/json
- **Accept**: application/json

34 changes: 16 additions & 18 deletions src/docs/Aws.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,19 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional]
**filter** | [**HttpFilter**](HttpFilter.md) | | [optional]
**transform** | [**HttpTransform**](HttpTransform.md) | | [optional]
**throttleMs** | **Number** | | [optional]
**url** | **String** | | [optional]
**httpHeaders** | **{String: String}** | | [optional]
**disableHttpHeaders** | **Boolean** | | [optional] [default to false]
**timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15]
**region** | **String** | | [optional]
**accessKeyId** | **String** | | [optional]
**accessKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional]
**messageGroupId** | **String** | | [optional]
**messageDeduplicationId** | **String** | | [optional]
**channel** | **String** | | [optional]


| Name | Type | Description | Notes |
| -------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------- |
| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] |
| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] |
| **transform** | [**HttpTransform**](HttpTransform.md) | | [optional] |
| **throttleMs** | **Number** | | [optional] |
| **url** | **String** | | [optional] |
| **httpHeaders** | **{String: String}** | | [optional] |
| **disableHttpHeaders** | **Boolean** | | [optional] [default to false] |
| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] |
| **region** | **String** | | [optional] |
| **accessKeyId** | **String** | | [optional] |
| **accessKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] |
| **messageGroupId** | **String** | | [optional] |
| **messageDeduplicationId** | **String** | | [optional] |
| **channel** | **String** | | [optional] |
24 changes: 11 additions & 13 deletions src/docs/Azure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional]
**filter** | [**HttpFilter**](HttpFilter.md) | | [optional]
**transform** | [**HttpTransform**](HttpTransform.md) | | [optional]
**throttleMs** | **Number** | | [optional]
**url** | **String** | | [optional]
**timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15]
**functionsKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional]
**sasPolicyName** | **String** | | [optional]
**sasPolicyKey** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional]


| Name | Type | Description | Notes |
| ---------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------- | -------------------------- |
| **fleets** | **[String]** | list of Fleet UIDs to apply route to, if any. If empty, applies to all Fleets | [optional] |
| **filter** | [**HttpFilter**](HttpFilter.md) | | [optional] |
| **transform** | [**HttpTransform**](HttpTransform.md) | | [optional] |
| **throttleMs** | **Number** | | [optional] |
| **url** | **String** | | [optional] |
| **timeout** | **Number** | Timeout in seconds for each request | [optional] [default to 15] |
| **functionsKeySecret** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] |
| **sasPolicyName** | **String** | | [optional] |
| **sasPolicyKey** | **String** | This value is input-only and will be omitted from the response and replaced with a placeholder | [optional] |
12 changes: 5 additions & 7 deletions src/docs/BillingAccount.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uid** | **String** | |
**name** | **String** | |
**role** | [**BillingAccountRole**](BillingAccountRole.md) | |


| Name | Type | Description | Notes |
| -------- | ----------------------------------------------- | ----------- | ----- |
| **uid** | **String** | |
| **name** | **String** | |
| **role** | [**BillingAccountRole**](BillingAccountRole.md) | |
33 changes: 16 additions & 17 deletions src/docs/BillingAccountApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,36 @@

All URIs are relative to *https://api.notefile.net*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getBillingAccounts**](BillingAccountApi.md#getBillingAccounts) | **GET** /v1/billing-accounts |


| Method | HTTP request | Description |
| ----------------------------------------------------------------- | ---------------------------- | ----------- |
| [**getBillingAccounts**](BillingAccountApi.md#getBillingAccounts) | **GET** /v1/billing-accounts |

## getBillingAccounts

> GetBillingAccounts200Response getBillingAccounts()


Get Billing Accounts accessible by the api_key

### Example

```javascript
import * as NotehubJs from '@blues-inc/notehub-js';
import * as NotehubJs from "@blues-inc/notehub-js";
let defaultClient = NotehubJs.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
let api_key = defaultClient.authentications["api_key"];
api_key.apiKey = "YOUR API KEY";

let apiInstance = new NotehubJs.BillingAccountApi();
apiInstance.getBillingAccounts().then((data) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, (error) => {
console.error(error);
});

apiInstance.getBillingAccounts().then(
(data) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
},
(error) => {
console.error(error);
}
);
```

### Parameters
Expand All @@ -50,4 +50,3 @@ This endpoint does not need any parameter.

- **Content-Type**: Not defined
- **Accept**: application/json

9 changes: 3 additions & 6 deletions src/docs/BillingAccountRole.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@

## Enum

- `billing_admin` (value: `"billing_admin"`)

* `billing_admin` (value: `"billing_admin"`)

* `billing_manager` (value: `"billing_manager"`)

* `project_creator` (value: `"project_creator"`)

- `billing_manager` (value: `"billing_manager"`)

- `project_creator` (value: `"project_creator"`)
8 changes: 3 additions & 5 deletions src/docs/Body.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**body** | **Object** | | [optional]


| Name | Type | Description | Notes |
| -------- | ---------- | ----------- | ---------- |
| **body** | **Object** | | [optional] |
14 changes: 6 additions & 8 deletions src/docs/Contact.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]
**email** | **String** | | [optional]
**role** | **String** | | [optional]
**organization** | **String** | | [optional]


| Name | Type | Description | Notes |
| ---------------- | ---------- | ----------- | ---------- |
| **name** | **String** | | [optional] |
| **email** | **String** | | [optional] |
| **role** | **String** | | [optional] |
| **organization** | **String** | | [optional] |
8 changes: 3 additions & 5 deletions src/docs/CreateFleetRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**label** | **String** | The label for the Fleet. | [optional]


| Name | Type | Description | Notes |
| --------- | ---------- | ------------------------ | ---------- |
| **label** | **String** | The label for the Fleet. | [optional] |
10 changes: 4 additions & 6 deletions src/docs/CreateProjectRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**label** | **String** | The label for the project. |
**billingAccountUid** | **String** | The billing account UID for the project. The caller of the API must be able to create projects within the billing account, otherwise an error will be returned. | [optional]


| Name | Type | Description | Notes |
| --------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| **label** | **String** | The label for the project. |
| **billingAccountUid** | **String** | The billing account UID for the project. The caller of the API must be able to create projects within the billing account, otherwise an error will be returned. | [optional] |
10 changes: 4 additions & 6 deletions src/docs/DFUEnv.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**card** | [**DFUState**](DFUState.md) | | [optional]
**user** | [**DFUState**](DFUState.md) | | [optional]


| Name | Type | Description | Notes |
| -------- | --------------------------- | ----------- | ---------- |
| **card** | [**DFUState**](DFUState.md) | | [optional] |
| **user** | [**DFUState**](DFUState.md) | | [optional] |
8 changes: 3 additions & 5 deletions src/docs/DeleteDeviceFleetsRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fleetUids** | **[String]** | The fleetUIDs to remove from the device. |


| Name | Type | Description | Notes |
| ------------- | ------------ | ---------------------------------------- | ----- |
| **fleetUids** | **[String]** | The fleetUIDs to remove from the device. |
36 changes: 17 additions & 19 deletions src/docs/Device.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,20 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uid** | **String** | |
**serialNumber** | **String** | |
**provisioned** | **Date** | |
**lastActivity** | **Date** | | [optional]
**contact** | [**Contact**](Contact.md) | | [optional]
**productUid** | **String** | |
**fleetUids** | **[String]** | |
**towerInfo** | [**DeviceTowerInfo**](DeviceTowerInfo.md) | | [optional]
**towerLocation** | [**Location**](Location.md) | | [optional]
**gpsLocation** | [**Location**](Location.md) | | [optional]
**triangulatedLocation** | [**Location**](Location.md) | | [optional]
**voltage** | **Number** | |
**temperature** | **Number** | |
**dfu** | [**DFUEnv**](DFUEnv.md) | | [optional]
**sku** | **String** | | [optional]


| Name | Type | Description | Notes |
| ------------------------ | ----------------------------------------- | ----------- | ---------- |
| **uid** | **String** | |
| **serialNumber** | **String** | |
| **provisioned** | **Date** | |
| **lastActivity** | **Date** | | [optional] |
| **contact** | [**Contact**](Contact.md) | | [optional] |
| **productUid** | **String** | |
| **fleetUids** | **[String]** | |
| **towerInfo** | [**DeviceTowerInfo**](DeviceTowerInfo.md) | | [optional] |
| **towerLocation** | [**Location**](Location.md) | | [optional] |
| **gpsLocation** | [**Location**](Location.md) | | [optional] |
| **triangulatedLocation** | [**Location**](Location.md) | | [optional] |
| **voltage** | **Number** | |
| **temperature** | **Number** | |
| **dfu** | [**DFUEnv**](DFUEnv.md) | | [optional] |
| **sku** | **String** | | [optional] |
Loading

0 comments on commit fa16d1a

Please sign in to comment.