npm package: 360_api
Description: JS API client generated by OpenAPI Generator
Latest version: 0.1.0

# 360_api

360Api - JavaScript client for 360_api
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 0.1.0
- Generator version: 7.7.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install 360_api --save
```

Finally, you need to build the module:

```shell
npm run build
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

To use the link you just defined in your project, switch to the directory you want to use your 360_api from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
npm run build
```

#### git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var 360Api = require('360_api');


var api = new 360Api.APIApi()
var apiName = "apiName_example"; // {String} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMeApiApiNameMeGet(apiName, callback);

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*360Api.APIApi* | [**getMeApiApiNameMeGet**](docs/APIApi.md#getMeApiApiNameMeGet) | **GET** /api/{api_name}/me | Get Me
*360Api.APIApi* | [**getMeApiApiNameMeOptions**](docs/APIApi.md#getMeApiApiNameMeOptions) | **OPTIONS** /api/{api_name}/me | Get Me
*360Api.APIApi* | [**getUserApisApiApisGet**](docs/APIApi.md#getUserApisApiApisGet) | **GET** /api/apis | Get User Apis
*360Api.APIApi* | [**getUserApisApiApisOptions**](docs/APIApi.md#getUserApisApiApisOptions) | **OPTIONS** /api/apis | Get User Apis
*360Api.APIApi* | [**linkApiToUserApiApiNameLinkOptions**](docs/APIApi.md#linkApiToUserApiApiNameLinkOptions) | **OPTIONS** /api/{api_name}/link | Link Api To User
*360Api.APIApi* | [**linkApiToUserApiApiNameLinkPost**](docs/APIApi.md#linkApiToUserApiApiNameLinkPost) | **POST** /api/{api_name}/link | Link Api To User
*360Api.APIApi* | [**meApiMeGet**](docs/APIApi.md#meApiMeGet) | **GET** /api/me | Me
*360Api.APIApi* | [**meApiMeOptions**](docs/APIApi.md#meApiMeOptions) | **OPTIONS** /api/me | Me
*360Api.APIApi* | [**setCompanyApiNameSetCompanyPost**](docs/APIApi.md#setCompanyApiNameSetCompanyPost) | **POST** /{api_name}/set_company | Set Company
*360Api.APIApi* | [**unlinkApiFromUserApiApiNameUnlinkGet**](docs/APIApi.md#unlinkApiFromUserApiApiNameUnlinkGet) | **GET** /api/{api_name}/unlink | Unlink Api From User
*360Api.APIApi* | [**unlinkApiFromUserApiApiNameUnlinkOptions**](docs/APIApi.md#unlinkApiFromUserApiApiNameUnlinkOptions) | **OPTIONS** /api/{api_name}/unlink | Unlink Api From User
*360Api.Class360AdminRoutesApi* | [**loginAdminLoginAdminGet**](docs/Class360AdminRoutesApi.md#loginAdminLoginAdminGet) | **GET** /login_admin | Login Admin
*360Api.Class360AdminRoutesApi* | [**postLogoutPostLogoutGet**](docs/Class360AdminRoutesApi.md#postLogoutPostLogoutGet) | **GET** /post_logout | Post Logout
*360Api.DefaultApi* | [**getDeviceVideoStreamApiApiNameDevicesIdentifierVideoGet**](docs/DefaultApi.md#getDeviceVideoStreamApiApiNameDevicesIdentifierVideoGet) | **GET** /api/{api_name}/devices/{identifier}/video | Get Device Video Stream
*360Api.DefaultApi* | [**getDevicesApiDevicesGet**](docs/DefaultApi.md#getDevicesApiDevicesGet) | **GET** /api/devices | Get Devices
*360Api.PowerBIApi* | [**getDashboardGroupsHandlerApiV1BiDashboardGroupsGet**](docs/PowerBIApi.md#getDashboardGroupsHandlerApiV1BiDashboardGroupsGet) | **GET** /api/v1/bi/dashboard_groups | Get Dashboard Groups Handler
*360Api.PowerBIApi* | [**getDashboardHandlerApiV1BiDashboardDashboardIdGet**](docs/PowerBIApi.md#getDashboardHandlerApiV1BiDashboardDashboardIdGet) | **GET** /api/v1/bi/dashboard/{dashboard_id} | Get Dashboard Handler
*360Api.PowerBIApi* | [**getDashboardTypesHandlerApiV1BiDashboardTypesGet**](docs/PowerBIApi.md#getDashboardTypesHandlerApiV1BiDashboardTypesGet) | **GET** /api/v1/bi/dashboard_types | Get Dashboard Types Handler
*360Api.PowerBIApi* | [**getDashboardsHandlerApiV1BiDashboardsGet**](docs/PowerBIApi.md#getDashboardsHandlerApiV1BiDashboardsGet) | **GET** /api/v1/bi/dashboards/ | Get Dashboards Handler
*360Api.PowerBIApi* | [**getEmbedUrlApiV1BiEmbedUrlReportIdGet**](docs/PowerBIApi.md#getEmbedUrlApiV1BiEmbedUrlReportIdGet) | **GET** /api/v1/bi/embed_url/{report_id} | Get Embed Url
*360Api.PowerBIApi* | [**getReportUuidApiV1BiGenerateReportUuidPost**](docs/PowerBIApi.md#getReportUuidApiV1BiGenerateReportUuidPost) | **POST** /api/v1/bi/generate_report_uuid | Get Report Uuid
*360Api.ProviderApi* | [**createAuthTypeHandlerApiV1ProviderAuthTypesPost**](docs/ProviderApi.md#createAuthTypeHandlerApiV1ProviderAuthTypesPost) | **POST** /api/v1/provider/auth-types | Create Auth Type Handler
*360Api.ProviderApi* | [**createCredentialHandlerApiV1ProviderCredentialsPost**](docs/ProviderApi.md#createCredentialHandlerApiV1ProviderCredentialsPost) | **POST** /api/v1/provider/credentials | Create Credential Handler
*360Api.ProviderApi* | [**createProviderHandlerApiV1ProviderProvidersPost**](docs/ProviderApi.md#createProviderHandlerApiV1ProviderProvidersPost) | **POST** /api/v1/provider/providers | Create Provider Handler
*360Api.ProviderApi* | [**createProviderVersionHandlerApiV1ProviderProviderVersionsPost**](docs/ProviderApi.md#createProviderVersionHandlerApiV1ProviderProviderVersionsPost) | **POST** /api/v1/provider/provider-versions | Create Provider Version Handler
*360Api.ProviderApi* | [**deactivateAuthTypeHandlerApiV1ProviderAuthTypesAuthTypeIdDelete**](docs/ProviderApi.md#deactivateAuthTypeHandlerApiV1ProviderAuthTypesAuthTypeIdDelete) | **DELETE** /api/v1/provider/auth-types/{auth_type_id} | Deactivate Auth Type Handler
*360Api.ProviderApi* | [**deactivateCredentialHandlerApiV1ProviderCredentialsCredentialIdDelete**](docs/ProviderApi.md#deactivateCredentialHandlerApiV1ProviderCredentialsCredentialIdDelete) | **DELETE** /api/v1/provider/credentials/{credential_id} | Deactivate Credential Handler
*360Api.ProviderApi* | [**deactivateProviderHandlerApiV1ProviderProvidersProviderIdDelete**](docs/ProviderApi.md#deactivateProviderHandlerApiV1ProviderProvidersProviderIdDelete) | **DELETE** /api/v1/provider/providers/{provider_id} | Deactivate Provider Handler
*360Api.ProviderApi* | [**deactivateProviderVersionHandlerApiV1ProviderProviderVersionsVersionIdDelete**](docs/ProviderApi.md#deactivateProviderVersionHandlerApiV1ProviderProviderVersionsVersionIdDelete) | **DELETE** /api/v1/provider/provider-versions/{version_id} | Deactivate Provider Version Handler
*360Api.ProviderApi* | [**getAProviderHandlerApiV1ProviderProvidersProviderIdGet**](docs/ProviderApi.md#getAProviderHandlerApiV1ProviderProvidersProviderIdGet) | **GET** /api/v1/provider/providers/{provider_id} | Get A Provider Handler
*360Api.ProviderApi* | [**getAProviderVersionHandlerApiV1ProviderProviderVersionsVersionIdGet**](docs/ProviderApi.md#getAProviderVersionHandlerApiV1ProviderProviderVersionsVersionIdGet) | **GET** /api/v1/provider/provider-versions/{version_id} | Get A Provider Version Handler
*360Api.ProviderApi* | [**getAnAuthTypeHandlerApiV1ProviderAuthTypesAuthTypeIdGet**](docs/ProviderApi.md#getAnAuthTypeHandlerApiV1ProviderAuthTypesAuthTypeIdGet) | **GET** /api/v1/provider/auth-types/{auth_type_id} | Get An Auth Type Handler
*360Api.ProviderApi* | [**getAuthTypesHandlerApiV1ProviderAuthTypesGet**](docs/ProviderApi.md#getAuthTypesHandlerApiV1ProviderAuthTypesGet) | **GET** /api/v1/provider/auth-types | Get Auth Types Handler
*360Api.ProviderApi* | [**getAvailableProvidersHandlerApiV1ProviderAvailableGet**](docs/ProviderApi.md#getAvailableProvidersHandlerApiV1ProviderAvailableGet) | **GET** /api/v1/provider/available | Get Available Providers Handler
*360Api.ProviderApi* | [**getLinkedProvidersHandlerApiV1ProviderLinkedGet**](docs/ProviderApi.md#getLinkedProvidersHandlerApiV1ProviderLinkedGet) | **GET** /api/v1/provider/linked | Get Linked Providers Handler
*360Api.ProviderApi* | [**getLinkedProvidersHandlerApiV1ProviderLinkedOptions**](docs/ProviderApi.md#getLinkedProvidersHandlerApiV1ProviderLinkedOptions) | **OPTIONS** /api/v1/provider/linked | Get Linked Providers Handler
*360Api.ProviderApi* | [**getLinkedProvidersStatusHandlerApiV1ProviderLinkedStatusGet**](docs/ProviderApi.md#getLinkedProvidersStatusHandlerApiV1ProviderLinkedStatusGet) | **GET** /api/v1/provider/linked-status | Get Linked Providers Status Handler
*360Api.ProviderApi* | [**getLinkedProvidersStatusHandlerApiV1ProviderLinkedStatusOptions**](docs/ProviderApi.md#getLinkedProvidersStatusHandlerApiV1ProviderLinkedStatusOptions) | **OPTIONS** /api/v1/provider/linked-status | Get Linked Providers Status Handler
*360Api.ProviderApi* | [**getProviderVersionsHandlerApiV1ProviderProviderVersionsGet**](docs/ProviderApi.md#getProviderVersionsHandlerApiV1ProviderProviderVersionsGet) | **GET** /api/v1/provider/provider-versions | Get Provider Versions Handler
*360Api.ProviderApi* | [**getProvidersHandlerApiV1ProviderProvidersGet**](docs/ProviderApi.md#getProvidersHandlerApiV1ProviderProvidersGet) | **GET** /api/v1/provider/providers | Get Providers Handler
*360Api.ProviderApi* | [**linkProviderHandlerApiV1ProviderLinkProviderPost**](docs/ProviderApi.md#linkProviderHandlerApiV1ProviderLinkProviderPost) | **POST** /api/v1/provider/link-provider | Link Provider Handler
*360Api.ProviderApi* | [**unlinkProviderHandlerApiV1ProviderUnlinkProviderPost**](docs/ProviderApi.md#unlinkProviderHandlerApiV1ProviderUnlinkProviderPost) | **POST** /api/v1/provider/unlink-provider | Unlink Provider Handler
*360Api.ProviderApi* | [**updateAuthTypeHandlerApiV1ProviderAuthTypesPatch**](docs/ProviderApi.md#updateAuthTypeHandlerApiV1ProviderAuthTypesPatch) | **PATCH** /api/v1/provider/auth-types | Update Auth Type Handler
*360Api.ProviderApi* | [**updateCredentialHandlerApiV1ProviderCredentialsPatch**](docs/ProviderApi.md#updateCredentialHandlerApiV1ProviderCredentialsPatch) | **PATCH** /api/v1/provider/credentials | Update Credential Handler
*360Api.ProviderApi* | [**updateProviderHandlerApiV1ProviderProvidersPatch**](docs/ProviderApi.md#updateProviderHandlerApiV1ProviderProvidersPatch) | **PATCH** /api/v1/provider/providers | Update Provider Handler
*360Api.ProviderApi* | [**updateProviderVersionHandlerApiV1ProviderProviderVersionsPatch**](docs/ProviderApi.md#updateProviderVersionHandlerApiV1ProviderProviderVersionsPatch) | **PATCH** /api/v1/provider/provider-versions | Update Provider Version Handler
*360Api.ProviderRelayApi* | [**providerRelayApiV1ProviderRestOfPathDelete**](docs/ProviderRelayApi.md#providerRelayApiV1ProviderRestOfPathDelete) | **DELETE** /api/v1/provider/{rest_of_path} | Provider Relay
*360Api.ProviderRelayApi* | [**providerRelayApiV1ProviderRestOfPathGet**](docs/ProviderRelayApi.md#providerRelayApiV1ProviderRestOfPathGet) | **GET** /api/v1/provider/{rest_of_path} | Provider Relay
*360Api.ProviderRelayApi* | [**providerRelayApiV1ProviderRestOfPathOptions**](docs/ProviderRelayApi.md#providerRelayApiV1ProviderRestOfPathOptions) | **OPTIONS** /api/v1/provider/{rest_of_path} | Provider Relay
*360Api.ProviderRelayApi* | [**providerRelayApiV1ProviderRestOfPathPatch**](docs/ProviderRelayApi.md#providerRelayApiV1ProviderRestOfPathPatch) | **PATCH** /api/v1/provider/{rest_of_path} | Provider Relay
*360Api.ProviderRelayApi* | [**providerRelayApiV1ProviderRestOfPathPost**](docs/ProviderRelayApi.md#providerRelayApiV1ProviderRestOfPathPost) | **POST** /api/v1/provider/{rest_of_path} | Provider Relay
*360Api.ProviderRelayApi* | [**providerRelayApiV1ProviderRestOfPathPut**](docs/ProviderRelayApi.md#providerRelayApiV1ProviderRestOfPathPut) | **PUT** /api/v1/provider/{rest_of_path} | Provider Relay
*360Api.SurfSightRelayApi* | [**csvGeneratorApiV1SurfsightGenerateCsvPost**](docs/SurfSightRelayApi.md#csvGeneratorApiV1SurfsightGenerateCsvPost) | **POST** /api/v1/surfsight/generate-csv | Csv Generator
*360Api.SurfSightRelayApi* | [**videoCheckApiV1SurfsightVideoCheckPost**](docs/SurfSightRelayApi.md#videoCheckApiV1SurfsightVideoCheckPost) | **POST** /api/v1/surfsight/video-check | Video Check
*360Api.SurfsightRelayApi* | [**getEventsApiV1SurfsightGetEventsGet**](docs/SurfsightRelayApi.md#getEventsApiV1SurfsightGetEventsGet) | **GET** /api/v1/surfsight/get-events | Get Events
*360Api.UserApi* | [**createUserHandlerApiV1UserSyncSsoUserPost**](docs/UserApi.md#createUserHandlerApiV1UserSyncSsoUserPost) | **POST** /api/v1/user/sync_sso_user | Create User Handler


## Documentation for Models

 - [360Api.APIResponse](docs/APIResponse.md)
 - [360Api.APIResponses](docs/APIResponses.md)
 - [360Api.CSVGenerationRequest](docs/CSVGenerationRequest.md)
 - [360Api.CSVGenerationResponse](docs/CSVGenerationResponse.md)
 - [360Api.CredentialCreate](docs/CredentialCreate.md)
 - [360Api.CredentialGet](docs/CredentialGet.md)
 - [360Api.CredentialUpdate](docs/CredentialUpdate.md)
 - [360Api.DashboardGroupSchema](docs/DashboardGroupSchema.md)
 - [360Api.DashboardSchema](docs/DashboardSchema.md)
 - [360Api.DashboardTypeSchema](docs/DashboardTypeSchema.md)
 - [360Api.EmbedUrlv2Response](docs/EmbedUrlv2Response.md)
 - [360Api.GetDashboardGroupsResponse](docs/GetDashboardGroupsResponse.md)
 - [360Api.GetDashboardResponse](docs/GetDashboardResponse.md)
 - [360Api.GetDashboardTypesResponse](docs/GetDashboardTypesResponse.md)
 - [360Api.GetDashboardsResponse](docs/GetDashboardsResponse.md)
 - [360Api.HTTPValidationError](docs/HTTPValidationError.md)
 - [360Api.LinkAPIRequest](docs/LinkAPIRequest.md)
 - [360Api.LinkProviderRequest](docs/LinkProviderRequest.md)
 - [360Api.ProviderAuthenticationTypeCreate](docs/ProviderAuthenticationTypeCreate.md)
 - [360Api.ProviderAuthenticationTypeGet](docs/ProviderAuthenticationTypeGet.md)
 - [360Api.ProviderAuthenticationTypeUpdate](docs/ProviderAuthenticationTypeUpdate.md)
 - [360Api.ProviderCreate](docs/ProviderCreate.md)
 - [360Api.ProviderGet](docs/ProviderGet.md)
 - [360Api.ProviderUpdate](docs/ProviderUpdate.md)
 - [360Api.ProviderVersionCreate](docs/ProviderVersionCreate.md)
 - [360Api.ProviderVersionGet](docs/ProviderVersionGet.md)
 - [360Api.ProviderVersionUpdate](docs/ProviderVersionUpdate.md)
 - [360Api.ResponseValidatorMulti](docs/ResponseValidatorMulti.md)
 - [360Api.ResponseValidatorSingle](docs/ResponseValidatorSingle.md)
 - [360Api.SSOUserCreate](docs/SSOUserCreate.md)
 - [360Api.UnlinkProviderRequest](docs/UnlinkProviderRequest.md)
 - [360Api.ValidationError](docs/ValidationError.md)
 - [360Api.ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
 - [360Api.VideoHealthCheckResponse](docs/VideoHealthCheckResponse.md)


## Documentation for Authorization


Authentication schemes defined for the API:
### OAuth2PasswordBearer


- **Type**: OAuth
- **Flow**: password
- **Authorization URL**: 
- **Scopes**: N/A