# insights_hsdm_api

> This_is_a_API_to_fetch_and_order_catalog_items_from_different_cloud_sources

Latest version **1.6.0** (published 2018-07-05) · Apache 2.0 license · 0 weekly downloads

## Install

```sh
npm install insights_hsdm_api
pnpm add insights_hsdm_api
yarn add insights_hsdm_api
bun add insights_hsdm_api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.0 |
| Published | 2018-07-05 |
| First published | 2018-06-25 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 164.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | insights-hsdm |

## Links

- npm: https://www.npmjs.com/package/insights_hsdm_api
- npm.io page: https://npm.io/package/insights_hsdm_api

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) 3.5.2

## Recent versions

- 1.6.0 (latest) — 2018-07-05
- 1.5.0 — 2018-07-05
- 1.4.0 — 2018-07-02
- 1.3.0 — 2018-07-02
- 1.2.0 — 2018-07-01
- 1.1.0 — 2018-07-01
- 1.0.0 — 2018-06-25

## README

# insights_hsdm_api

InsightsHsdmApi - JavaScript client for insights_hsdm_api
This is a API to fetch and order catalog items from different cloud sources
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.6.0
- Package version: 1.6.0
- Build package: io.swagger.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 insights_hsdm_api --save
```

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

Finally, switch to the directory you want to use your insights_hsdm_api from, and run:

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

You should now be able to `require('insights_hsdm_api')` in javascript files from the directory you ran the last 
command above from.

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

```shell
    npm install YOUR_USERNAME/insights_hsdm_api --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, that's to say your javascript file where you actually 
use this library):

```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 InsightsHsdmApi = require('insights_hsdm_api');

var defaultClient = InsightsHsdmApi.ApiClient.instance;

// Configure HTTP basic authorization: UserSecurity
var UserSecurity = defaultClient.authentications['UserSecurity'];
UserSecurity.username = 'YOUR USERNAME'
UserSecurity.password = 'YOUR PASSWORD'

var api = new InsightsHsdmApi.UsersApi()

var body = new InsightsHsdmApi.Provider(); // {Provider} 

api.addProvider(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

All URIs are relative to *https://virtserver.swaggerhub.com/mkanoor/InsightsCatalog/1.0.0*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*InsightsHsdmApi.UsersApi* | [**addProvider**](docs/UsersApi.md#addProvider) | **POST** /providers | Temporary API to add a new provider
*InsightsHsdmApi.UsersApi* | [**addToOrder**](docs/UsersApi.md#addToOrder) | **POST** /orders/{order_id}/items | Add a Catalog to the Order in Pending State
*InsightsHsdmApi.UsersApi* | [**catalogItems**](docs/UsersApi.md#catalogItems) | **GET** /catalog_items | fetches catalog items from all providers
*InsightsHsdmApi.UsersApi* | [**fetchCatalogItemWithProvider**](docs/UsersApi.md#fetchCatalogItemWithProvider) | **GET** /providers/{provider_id}/catalog_items | Fetch all or a specific catalog item from a specific provider
*InsightsHsdmApi.UsersApi* | [**fetchCatalogItemWithProviderAndCatalogID**](docs/UsersApi.md#fetchCatalogItemWithProviderAndCatalogID) | **GET** /providers/{provider_id}/catalog_items/{catalog_id} | Fetches a specific catalog item for a provider
*InsightsHsdmApi.UsersApi* | [**listOrderItem**](docs/UsersApi.md#listOrderItem) | **GET** /orders/{order_id}/items/{order_item_id} | Get an individual item from a given order
*InsightsHsdmApi.UsersApi* | [**listOrderItems**](docs/UsersApi.md#listOrderItems) | **GET** /orders/{order_id}/items | Get a list of items in a given order
*InsightsHsdmApi.UsersApi* | [**listOrders**](docs/UsersApi.md#listOrders) | **GET** /orders | Get a list of orders
*InsightsHsdmApi.UsersApi* | [**listProgressMessages**](docs/UsersApi.md#listProgressMessages) | **GET** /order_items/{order_item_id}/progress_messages | Get a list of progress messages in an item
*InsightsHsdmApi.UsersApi* | [**listProviders**](docs/UsersApi.md#listProviders) | **GET** /providers | Temporary API to list provider
*InsightsHsdmApi.UsersApi* | [**newOrder**](docs/UsersApi.md#newOrder) | **POST** /orders | Create a new order
*InsightsHsdmApi.UsersApi* | [**planParameters**](docs/UsersApi.md#planParameters) | **GET** /providers/{provider_id}/catalog_items/{catalog_id}/catalog_plans/{plan_id}/parameters | Fetches plan parameters, it needs the provider id, the catalog_id and plan_id
*InsightsHsdmApi.UsersApi* | [**searchPlans**](docs/UsersApi.md#searchPlans) | **GET** /providers/{provider_id}/catalog_items/{catalog_id}/catalog_plans | searches avaliable plans for a catalog item
*InsightsHsdmApi.UsersApi* | [**submitOrder**](docs/UsersApi.md#submitOrder) | **POST** /orders/{order_id} | Submit the given order


## Documentation for Models

 - [InsightsHsdmApi.CatalogItem](docs/CatalogItem.md)
 - [InsightsHsdmApi.CatalogPlan](docs/CatalogPlan.md)
 - [InsightsHsdmApi.Order](docs/Order.md)
 - [InsightsHsdmApi.OrderItem](docs/OrderItem.md)
 - [InsightsHsdmApi.ParameterValue](docs/ParameterValue.md)
 - [InsightsHsdmApi.PlanParameter](docs/PlanParameter.md)
 - [InsightsHsdmApi.ProgressMessage](docs/ProgressMessage.md)
 - [InsightsHsdmApi.Provider](docs/Provider.md)


## Documentation for Authorization


### UserSecurity

- **Type**: HTTP basic authentication

---
_Source: https://npm.io/package/insights_hsdm_api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._