Skip to content

Commit

Permalink
docs: regenerate library
Browse files Browse the repository at this point in the history
  • Loading branch information
@paigen11
paigen11 committed Dec 5, 2023
1 parent 4f4b231 commit 66b34de
Show file tree
Hide file tree
Showing 5 changed files with 113 additions and 22 deletions.
1 change: 1 addition & 0 deletions src/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ All URIs are relative to *https://api.notefile.net*
| _NotehubJs.ProjectApi_ | [**cloneProject**](docs/ProjectApi.md#cloneProject) | **POST** /v1/projects/{projectUID}/clone |
| _NotehubJs.ProjectApi_ | [**createProduct**](docs/ProjectApi.md#createProduct) | **POST** /v1/projects/{projectUID}/products |
| _NotehubJs.ProjectApi_ | [**createProject**](docs/ProjectApi.md#createProject) | **POST** /v1/projects |
| _NotehubJs.ProjectApi_ | [**deleteProject**](docs/ProjectApi.md#deleteProject) | **DELETE** /v1/projects/{projectUID} |
| _NotehubJs.ProjectApi_ | [**deleteProjectEnvironmentVariable**](docs/ProjectApi.md#deleteProjectEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/environment_variables/{key} |
| _NotehubJs.ProjectApi_ | [**disableGlobalTransformation**](docs/ProjectApi.md#disableGlobalTransformation) | **POST** /v1/projects/{projectUID}/global-transformation/disable |
| _NotehubJs.ProjectApi_ | [**enableGlobalTransformation**](docs/ProjectApi.md#enableGlobalTransformation) | **POST** /v1/projects/{projectUID}/global-transformation/enable |
Expand Down
6 changes: 1 addition & 5 deletions src/docs/EventApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -226,9 +226,7 @@ let opts = {
'sortOrder': "'asc'", // String |
'systemFilesOnly': true, // Boolean |
'files': _health.qo, data.qo, // String |
'deviceUID': "deviceUID_example", // String | A Device UID.
'startDate': 1628631763, // Number | Unix timestamp
'endDate': 1657894210 // Number | Unix timestamp
'deviceUID': "deviceUID_example" // String | A Device UID.
};
apiInstance.getProjectEventsByCursor(projectUID, opts).then((data) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
Expand All @@ -249,8 +247,6 @@ apiInstance.getProjectEventsByCursor(projectUID, opts).then((data) => {
| **systemFilesOnly** | **Boolean** | | [optional] |
| **files** | **String** | | [optional] |
| **deviceUID** | **String** | A Device UID. | [optional] |
| **startDate** | **Number** | Unix timestamp | [optional] |
| **endDate** | **Number** | Unix timestamp | [optional] |

### Return type

Expand Down
55 changes: 50 additions & 5 deletions src/docs/ProjectApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ All URIs are relative to *https://api.notefile.net*
| [**cloneProject**](ProjectApi.md#cloneProject) | **POST** /v1/projects/{projectUID}/clone |
| [**createProduct**](ProjectApi.md#createProduct) | **POST** /v1/projects/{projectUID}/products |
| [**createProject**](ProjectApi.md#createProject) | **POST** /v1/projects |
| [**deleteProject**](ProjectApi.md#deleteProject) | **DELETE** /v1/projects/{projectUID} |
| [**deleteProjectEnvironmentVariable**](ProjectApi.md#deleteProjectEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/environment_variables/{key} |
| [**disableGlobalTransformation**](ProjectApi.md#disableGlobalTransformation) | **POST** /v1/projects/{projectUID}/global-transformation/disable |
| [**enableGlobalTransformation**](ProjectApi.md#enableGlobalTransformation) | **POST** /v1/projects/{projectUID}/global-transformation/enable |
Expand Down Expand Up @@ -169,6 +170,54 @@ apiInstance.createProject(createProjectRequest).then(
- **Content-Type**: application/json
- **Accept**: application/json

## deleteProject

> deleteProject(projectUID, opts)
Delete a Project by ProjectUID

### Example

```javascript
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 apiInstance = new NotehubJs.ProjectApi();
let projectUID = app:2606f411-dea6-44a0-9743-1130f57d77d8; // String |
let opts = {
'db': false // Boolean |
};
apiInstance.deleteProject(projectUID, opts).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});

```

### Parameters

| Name | Type | Description | Notes |
| -------------- | ----------- | ----------- | ----------------------------- |
| **projectUID** | **String** | |
| **db** | **Boolean** | | [optional] [default to false] |

### Return type

null (empty response body)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

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

## deleteProjectEnvironmentVariable

> EnvironmentVariables deleteProjectEnvironmentVariable(projectUID, key)
Expand Down Expand Up @@ -626,9 +675,7 @@ let opts = {
'sortOrder': "'asc'", // String |
'systemFilesOnly': true, // Boolean |
'files': _health.qo, data.qo, // String |
'deviceUID': "deviceUID_example", // String | A Device UID.
'startDate': 1628631763, // Number | Unix timestamp
'endDate': 1657894210 // Number | Unix timestamp
'deviceUID': "deviceUID_example" // String | A Device UID.
};
apiInstance.getProjectEventsByCursor(projectUID, opts).then((data) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
Expand All @@ -649,8 +696,6 @@ apiInstance.getProjectEventsByCursor(projectUID, opts).then((data) => {
| **systemFilesOnly** | **Boolean** | | [optional] |
| **files** | **String** | | [optional] |
| **deviceUID** | **String** | A Device UID. | [optional] |
| **startDate** | **Number** | Unix timestamp | [optional] |
| **endDate** | **Number** | Unix timestamp | [optional] |

### Return type

Expand Down
6 changes: 0 additions & 6 deletions src/src/api/EventApi.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -315,8 +315,6 @@ export default class EventApi {
* @param {Boolean} opts.systemFilesOnly
* @param {String} opts.files
* @param {String} opts.deviceUID A Device UID.
* @param {Number} opts.startDate Unix timestamp
* @param {Number} opts.endDate Unix timestamp
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetProjectEventsByCursor200Response} and HTTP response
*/
getProjectEventsByCursorWithHttpInfo(projectUID, opts) {
Expand All @@ -339,8 +337,6 @@ export default class EventApi {
systemFilesOnly: opts["systemFilesOnly"],
files: opts["files"],
deviceUID: opts["deviceUID"],
startDate: opts["startDate"],
endDate: opts["endDate"],
};
let headerParams = {};
let formParams = {};
Expand Down Expand Up @@ -375,8 +371,6 @@ export default class EventApi {
* @param {Boolean} opts.systemFilesOnly
* @param {String} opts.files
* @param {String} opts.deviceUID A Device UID.
* @param {Number} opts.startDate Unix timestamp
* @param {Number} opts.endDate Unix timestamp
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetProjectEventsByCursor200Response}
*/
getProjectEventsByCursor(projectUID, opts) {
Expand Down
67 changes: 61 additions & 6 deletions src/src/api/ProjectApi.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,67 @@ export default class ProjectApi {
});
}

/**
* Delete a Project by ProjectUID
* @param {String} projectUID
* @param {Object} opts Optional parameters
* @param {Boolean} opts.db (default to false)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
*/
deleteProjectWithHttpInfo(projectUID, opts) {
opts = opts || {};
let postBody = null;
// verify the required parameter 'projectUID' is set
if (projectUID === undefined || projectUID === null) {
throw new Error(
"Missing the required parameter 'projectUID' when calling deleteProject"
);
}

let pathParams = {
projectUID: projectUID,
};
let queryParams = {
db: opts["db"],
};
let headerParams = {};
let formParams = {};

let authNames = ["api_key"];
let contentTypes = [];
let accepts = ["application/json"];
let returnType = null;
return this.apiClient.callApi(
"/v1/projects/{projectUID}",
"DELETE",
pathParams,
queryParams,
headerParams,
formParams,
postBody,
authNames,
contentTypes,
accepts,
returnType,
null
);
}

/**
* Delete a Project by ProjectUID
* @param {String} projectUID
* @param {Object} opts Optional parameters
* @param {Boolean} opts.db (default to false)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
*/
deleteProject(projectUID, opts) {
return this.deleteProjectWithHttpInfo(projectUID, opts).then(function (
response_and_data
) {
return response_and_data.data;
});
}

/**
* Delete an environment variable of a project by key
* @param {String} projectUID
Expand Down Expand Up @@ -779,8 +840,6 @@ export default class ProjectApi {
* @param {Boolean} opts.systemFilesOnly
* @param {String} opts.files
* @param {String} opts.deviceUID A Device UID.
* @param {Number} opts.startDate Unix timestamp
* @param {Number} opts.endDate Unix timestamp
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetProjectEventsByCursor200Response} and HTTP response
*/
getProjectEventsByCursorWithHttpInfo(projectUID, opts) {
Expand All @@ -803,8 +862,6 @@ export default class ProjectApi {
systemFilesOnly: opts["systemFilesOnly"],
files: opts["files"],
deviceUID: opts["deviceUID"],
startDate: opts["startDate"],
endDate: opts["endDate"],
};
let headerParams = {};
let formParams = {};
Expand Down Expand Up @@ -839,8 +896,6 @@ export default class ProjectApi {
* @param {Boolean} opts.systemFilesOnly
* @param {String} opts.files
* @param {String} opts.deviceUID A Device UID.
* @param {Number} opts.startDate Unix timestamp
* @param {Number} opts.endDate Unix timestamp
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetProjectEventsByCursor200Response}
*/
getProjectEventsByCursor(projectUID, opts) {
Expand Down

0 comments on commit 66b34de

Please sign in to comment.