Catalog npm
PACKAGE EXPLORERView in registry

360_api

npm

JS API client generated by OpenAPI Generator

Versions collected1
Direct dependencies24From release 0.1.0
Last observed20 Oct, 19:26 UTC

README

Current package documentation

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 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

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install 360_api --save

Finally, you need to build the module:

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:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

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:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

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:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. 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):

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:

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

Getting Started

Please follow the installation instruction and execute the following JS code:

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

ClassMethodHTTP requestDescription
360Api.APIApigetMeApiApiNameMeGetGET /api/{api_name}/meGet Me
360Api.APIApigetMeApiApiNameMeOptionsOPTIONS /api/{api_name}/meGet Me
360Api.APIApigetUserApisApiApisGetGET /api/apisGet User Apis
360Api.APIApigetUserApisApiApisOptionsOPTIONS /api/apisGet User Apis
360Api.APIApilinkApiToUserApiApiNameLinkOptionsOPTIONS /api/{api_name}/linkLink Api To User
360Api.APIApilinkApiToUserApiApiNameLinkPostPOST /api/{api_name}/linkLink Api To User
360Api.APIApimeApiMeGetGET /api/meMe
360Api.APIApimeApiMeOptionsOPTIONS /api/meMe
360Api.APIApisetCompanyApiNameSetCompanyPostPOST /{api_name}/set_companySet Company
360Api.APIApiunlinkApiFromUserApiApiNameUnlinkGetGET /api/{api_name}/unlinkUnlink Api From User
360Api.APIApiunlinkApiFromUserApiApiNameUnlinkOptionsOPTIONS /api/{api_name}/unlinkUnlink Api From User
360Api.Class360AdminRoutesApiloginAdminLoginAdminGetGET /login_adminLogin Admin
360Api.Class360AdminRoutesApipostLogoutPostLogoutGetGET /post_logoutPost Logout
360Api.DefaultApigetDeviceVideoStreamApiApiNameDevicesIdentifierVideoGetGET /api/{api_name}/devices/{identifier}/videoGet Device Video Stream
360Api.DefaultApigetDevicesApiDevicesGetGET /api/devicesGet Devices
360Api.PowerBIApigetDashboardGroupsHandlerApiV1BiDashboardGroupsGetGET /api/v1/bi/dashboard_groupsGet Dashboard Groups Handler
360Api.PowerBIApigetDashboardHandlerApiV1BiDashboardDashboardIdGetGET /api/v1/bi/dashboard/{dashboard_id}Get Dashboard Handler
360Api.PowerBIApigetDashboardTypesHandlerApiV1BiDashboardTypesGetGET /api/v1/bi/dashboard_typesGet Dashboard Types Handler
360Api.PowerBIApigetDashboardsHandlerApiV1BiDashboardsGetGET /api/v1/bi/dashboards/Get Dashboards Handler
360Api.PowerBIApigetEmbedUrlApiV1BiEmbedUrlReportIdGetGET /api/v1/bi/embed_url/{report_id}Get Embed Url
360Api.PowerBIApigetReportUuidApiV1BiGenerateReportUuidPostPOST /api/v1/bi/generate_report_uuidGet Report Uuid
360Api.ProviderApicreateAuthTypeHandlerApiV1ProviderAuthTypesPostPOST /api/v1/provider/auth-typesCreate Auth Type Handler
360Api.ProviderApicreateCredentialHandlerApiV1ProviderCredentialsPostPOST /api/v1/provider/credentialsCreate Credential Handler
360Api.ProviderApicreateProviderHandlerApiV1ProviderProvidersPostPOST /api/v1/provider/providersCreate Provider Handler
360Api.ProviderApicreateProviderVersionHandlerApiV1ProviderProviderVersionsPostPOST /api/v1/provider/provider-versionsCreate Provider Version Handler
360Api.ProviderApideactivateAuthTypeHandlerApiV1ProviderAuthTypesAuthTypeIdDeleteDELETE /api/v1/provider/auth-types/{auth_type_id}Deactivate Auth Type Handler
360Api.ProviderApideactivateCredentialHandlerApiV1ProviderCredentialsCredentialIdDeleteDELETE /api/v1/provider/credentials/{credential_id}Deactivate Credential Handler
360Api.ProviderApideactivateProviderHandlerApiV1ProviderProvidersProviderIdDeleteDELETE /api/v1/provider/providers/{provider_id}Deactivate Provider Handler
360Api.ProviderApideactivateProviderVersionHandlerApiV1ProviderProviderVersionsVersionIdDeleteDELETE /api/v1/provider/provider-versions/{version_id}Deactivate Provider Version Handler
360Api.ProviderApigetAProviderHandlerApiV1ProviderProvidersProviderIdGetGET /api/v1/provider/providers/{provider_id}Get A Provider Handler
360Api.ProviderApigetAProviderVersionHandlerApiV1ProviderProviderVersionsVersionIdGetGET /api/v1/provider/provider-versions/{version_id}Get A Provider Version Handler
360Api.ProviderApigetAnAuthTypeHandlerApiV1ProviderAuthTypesAuthTypeIdGetGET /api/v1/provider/auth-types/{auth_type_id}Get An Auth Type Handler
360Api.ProviderApigetAuthTypesHandlerApiV1ProviderAuthTypesGetGET /api/v1/provider/auth-typesGet Auth Types Handler
360Api.ProviderApigetAvailableProvidersHandlerApiV1ProviderAvailableGetGET /api/v1/provider/availableGet Available Providers Handler
360Api.ProviderApigetLinkedProvidersHandlerApiV1ProviderLinkedGetGET /api/v1/provider/linkedGet Linked Providers Handler
360Api.ProviderApigetLinkedProvidersHandlerApiV1ProviderLinkedOptionsOPTIONS /api/v1/provider/linkedGet Linked Providers Handler
360Api.ProviderApigetLinkedProvidersStatusHandlerApiV1ProviderLinkedStatusGetGET /api/v1/provider/linked-statusGet Linked Providers Status Handler
360Api.ProviderApigetLinkedProvidersStatusHandlerApiV1ProviderLinkedStatusOptionsOPTIONS /api/v1/provider/linked-statusGet Linked Providers Status Handler
360Api.ProviderApigetProviderVersionsHandlerApiV1ProviderProviderVersionsGetGET /api/v1/provider/provider-versionsGet Provider Versions Handler
360Api.ProviderApigetProvidersHandlerApiV1ProviderProvidersGetGET /api/v1/provider/providersGet Providers Handler
360Api.ProviderApilinkProviderHandlerApiV1ProviderLinkProviderPostPOST /api/v1/provider/link-providerLink Provider Handler
360Api.ProviderApiunlinkProviderHandlerApiV1ProviderUnlinkProviderPostPOST /api/v1/provider/unlink-providerUnlink Provider Handler
360Api.ProviderApiupdateAuthTypeHandlerApiV1ProviderAuthTypesPatchPATCH /api/v1/provider/auth-typesUpdate Auth Type Handler
360Api.ProviderApiupdateCredentialHandlerApiV1ProviderCredentialsPatchPATCH /api/v1/provider/credentialsUpdate Credential Handler
360Api.ProviderApiupdateProviderHandlerApiV1ProviderProvidersPatchPATCH /api/v1/provider/providersUpdate Provider Handler
360Api.ProviderApiupdateProviderVersionHandlerApiV1ProviderProviderVersionsPatchPATCH /api/v1/provider/provider-versionsUpdate Provider Version Handler
360Api.ProviderRelayApiproviderRelayApiV1ProviderRestOfPathDeleteDELETE /api/v1/provider/{rest_of_path}Provider Relay
360Api.ProviderRelayApiproviderRelayApiV1ProviderRestOfPathGetGET /api/v1/provider/{rest_of_path}Provider Relay
360Api.ProviderRelayApiproviderRelayApiV1ProviderRestOfPathOptionsOPTIONS /api/v1/provider/{rest_of_path}Provider Relay
360Api.ProviderRelayApiproviderRelayApiV1ProviderRestOfPathPatchPATCH /api/v1/provider/{rest_of_path}Provider Relay
360Api.ProviderRelayApiproviderRelayApiV1ProviderRestOfPathPostPOST /api/v1/provider/{rest_of_path}Provider Relay
360Api.ProviderRelayApiproviderRelayApiV1ProviderRestOfPathPutPUT /api/v1/provider/{rest_of_path}Provider Relay
360Api.SurfSightRelayApicsvGeneratorApiV1SurfsightGenerateCsvPostPOST /api/v1/surfsight/generate-csvCsv Generator
360Api.SurfSightRelayApivideoCheckApiV1SurfsightVideoCheckPostPOST /api/v1/surfsight/video-checkVideo Check
360Api.SurfsightRelayApigetEventsApiV1SurfsightGetEventsGetGET /api/v1/surfsight/get-eventsGet Events
360Api.UserApicreateUserHandlerApiV1UserSyncSsoUserPostPOST /api/v1/user/sync_sso_userCreate User Handler

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

OAuth2PasswordBearer

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes: N/A

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
0.1.0Registry latest12 Jun 202424

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:26 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:70e63bfc6d1ef6d302d89458277167c043bdc4be2c3a3d0c615368285742a7a7