1.0.0 • Published 6 years ago

@manageiq/catalog-api-jsclient v1.0.0

Weekly downloads
24
License
Apache 2.0
Repository
-
Last release
6 years ago

@manageiq/catalog-api-jsclient

@ManageiqCatalogApiJsclient - JavaScript client for @manageiq/catalog-api-jsclient This API gets and orders catalog items from different cloud sources. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.1.0
  • Package version: 0.1.0
  • 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 @manageiq/catalog-api-jsclient --save

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 @ManageiqCatalogApiJsclient = require('@manageiq/catalog-api-jsclient');

var defaultClient = @ManageiqCatalogApiJsclient.ApiClient.instance;
// Configure API key authorization: APIKeyAuth
var APIKeyAuth = defaultClient.authentications['APIKeyAuth'];
APIKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKeyAuth.apiKeyPrefix['x-rh-auth-identity'] = "Token"
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new @ManageiqCatalogApiJsclient.AdminsApi()
var portfolioId = "portfolioId_example"; // {String} The Portfolio ID
var addPortfolioItem = new @ManageiqCatalogApiJsclient.AddPortfolioItem(); // {AddPortfolioItem} 
api.addPortfolioItemToPortfolio(portfolioId, addPortfolioItem).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://localhost/api/catalog

ClassMethodHTTP requestDescription
@ManageiqCatalogApiJsclient.AdminsApiaddPortfolioItemToPortfolioPOST /portfolios/{portfolio_id}/portfolio_itemsAdd a portfolio item to a portfolio
@ManageiqCatalogApiJsclient.AdminsApiaddToOrderPOST /orders/{order_id}/order_itemsAdd an order item to an order in pending state
@ManageiqCatalogApiJsclient.AdminsApicreateOrderPOST /ordersCreate a new order
@ManageiqCatalogApiJsclient.AdminsApicreatePortfolioPOST /portfoliosAdd a new portfolio
@ManageiqCatalogApiJsclient.AdminsApicreatePortfolioItemPOST /portfolio_itemsAdd a new portfolio item
@ManageiqCatalogApiJsclient.AdminsApidestroyPortfolioDELETE /portfolios/{id}Delete an existing portfolio
@ManageiqCatalogApiJsclient.AdminsApidestroyPortfolioItemDELETE /portfolio_items/{id}Delete an existing portfolio item
@ManageiqCatalogApiJsclient.AdminsApifetchPortfolioItemsWithPortfolioGET /portfolios/{portfolio_id}/portfolio_itemsGet all portfolio items from a specific portfolio
@ManageiqCatalogApiJsclient.AdminsApilistOrderItemsGET /orders/{order_id}/order_itemsGets a list of items in a given order
@ManageiqCatalogApiJsclient.AdminsApilistOrdersGET /ordersGet a list of orders
@ManageiqCatalogApiJsclient.AdminsApilistPortfolioItemsGET /portfolio_itemsList all portfolio items
@ManageiqCatalogApiJsclient.AdminsApilistPortfoliosGET /portfoliosList portfolios
@ManageiqCatalogApiJsclient.AdminsApilistProgressMessagesGET /order_items/{order_item_id}/progress_messagesGets a list of progress messages in an item
@ManageiqCatalogApiJsclient.AdminsApilistProviderControlParametersGET /portfolio_items/{portfolio_item_id}/provider_control_parametersGets the provider control parameters for this portfolio item; requires control paramaters provided when provisioning the portfolio item.
@ManageiqCatalogApiJsclient.AdminsApilistServicePlansGET /portfolio_items/{portfolio_item_id}/service_plansGets all service plans for a specific portfolio item; requires a connection to the topology service.
@ManageiqCatalogApiJsclient.AdminsApishareInfoGET /portfolios/{portfolio_id}/share_infoFetch share information about this portfolio, the response would include a collection of groups and permissions with each group
@ManageiqCatalogApiJsclient.AdminsApisharePortfolioPOST /portfolios/{portfolio_id}/shareShare a portfolio with one or more groups with specific permission
@ManageiqCatalogApiJsclient.AdminsApishowOrderItemGET /orders/{order_id}/order_items/{id}Gets an individual order item from a given order
@ManageiqCatalogApiJsclient.AdminsApishowPortfolioGET /portfolios/{id}Get a specific portfolio
@ManageiqCatalogApiJsclient.AdminsApishowPortfolioItemGET /portfolio_items/{id}Gets a specific portfolio item
@ManageiqCatalogApiJsclient.AdminsApisubmitOrderPOST /orders/{order_id}/submit_orderSubmit a given order
@ManageiqCatalogApiJsclient.AdminsApiunsharePortfolioPOST /portfolios/{portfolio_id}/unshareUnshare a portfolio from one or more groups with specific permission
@ManageiqCatalogApiJsclient.AdminsApiupdatePortfolioPATCH /portfolios/{id}Edit an existing portfolio
@ManageiqCatalogApiJsclient.DefaultApiupdatePortfolioItemPATCH /portfolio_items/{id}Edit an existing portfolio item
@ManageiqCatalogApiJsclient.UsersApiaddToOrderPOST /orders/{order_id}/order_itemsAdd an order item to an order in pending state
@ManageiqCatalogApiJsclient.UsersApifetchPortfolioItemsWithPortfolioGET /portfolios/{portfolio_id}/portfolio_itemsGet all portfolio items from a specific portfolio
@ManageiqCatalogApiJsclient.UsersApilistOrderItemsGET /orders/{order_id}/order_itemsGets a list of items in a given order
@ManageiqCatalogApiJsclient.UsersApilistOrdersGET /ordersGet a list of orders
@ManageiqCatalogApiJsclient.UsersApilistPortfolioItemsGET /portfolio_itemsList all portfolio items
@ManageiqCatalogApiJsclient.UsersApilistPortfoliosGET /portfoliosList portfolios
@ManageiqCatalogApiJsclient.UsersApilistProgressMessagesGET /order_items/{order_item_id}/progress_messagesGets a list of progress messages in an item
@ManageiqCatalogApiJsclient.UsersApilistProviderControlParametersGET /portfolio_items/{portfolio_item_id}/provider_control_parametersGets the provider control parameters for this portfolio item; requires control paramaters provided when provisioning the portfolio item.
@ManageiqCatalogApiJsclient.UsersApilistServicePlansGET /portfolio_items/{portfolio_item_id}/service_plansGets all service plans for a specific portfolio item; requires a connection to the topology service.
@ManageiqCatalogApiJsclient.UsersApishareInfoGET /portfolios/{portfolio_id}/share_infoFetch share information about this portfolio, the response would include a collection of groups and permissions with each group
@ManageiqCatalogApiJsclient.UsersApishowOrderItemGET /orders/{order_id}/order_items/{id}Gets an individual order item from a given order
@ManageiqCatalogApiJsclient.UsersApishowPortfolioGET /portfolios/{id}Get a specific portfolio
@ManageiqCatalogApiJsclient.UsersApishowPortfolioItemGET /portfolio_items/{id}Gets a specific portfolio item

Documentation for Models

Documentation for Authorization

APIKeyAuth

  • Type: API key
  • API key parameter name: x-rh-auth-identity
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication