Never-ending Pumpkin Mulch

    @manageiq/catalog-api-jsclient

    1.0.0 • Public • Published

    @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

    Class Method HTTP request Description
    @ManageiqCatalogApiJsclient.AdminsApi addPortfolioItemToPortfolio POST /portfolios/{portfolio_id}/portfolio_items Add a portfolio item to a portfolio
    @ManageiqCatalogApiJsclient.AdminsApi addToOrder POST /orders/{order_id}/order_items Add an order item to an order in pending state
    @ManageiqCatalogApiJsclient.AdminsApi createOrder POST /orders Create a new order
    @ManageiqCatalogApiJsclient.AdminsApi createPortfolio POST /portfolios Add a new portfolio
    @ManageiqCatalogApiJsclient.AdminsApi createPortfolioItem POST /portfolio_items Add a new portfolio item
    @ManageiqCatalogApiJsclient.AdminsApi destroyPortfolio DELETE /portfolios/{id} Delete an existing portfolio
    @ManageiqCatalogApiJsclient.AdminsApi destroyPortfolioItem DELETE /portfolio_items/{id} Delete an existing portfolio item
    @ManageiqCatalogApiJsclient.AdminsApi fetchPortfolioItemsWithPortfolio GET /portfolios/{portfolio_id}/portfolio_items Get all portfolio items from a specific portfolio
    @ManageiqCatalogApiJsclient.AdminsApi listOrderItems GET /orders/{order_id}/order_items Gets a list of items in a given order
    @ManageiqCatalogApiJsclient.AdminsApi listOrders GET /orders Get a list of orders
    @ManageiqCatalogApiJsclient.AdminsApi listPortfolioItems GET /portfolio_items List all portfolio items
    @ManageiqCatalogApiJsclient.AdminsApi listPortfolios GET /portfolios List portfolios
    @ManageiqCatalogApiJsclient.AdminsApi listProgressMessages GET /order_items/{order_item_id}/progress_messages Gets a list of progress messages in an item
    @ManageiqCatalogApiJsclient.AdminsApi listProviderControlParameters GET /portfolio_items/{portfolio_item_id}/provider_control_parameters Gets the provider control parameters for this portfolio item; requires control paramaters provided when provisioning the portfolio item.
    @ManageiqCatalogApiJsclient.AdminsApi listServicePlans GET /portfolio_items/{portfolio_item_id}/service_plans Gets all service plans for a specific portfolio item; requires a connection to the topology service.
    @ManageiqCatalogApiJsclient.AdminsApi shareInfo GET /portfolios/{portfolio_id}/share_info Fetch share information about this portfolio, the response would include a collection of groups and permissions with each group
    @ManageiqCatalogApiJsclient.AdminsApi sharePortfolio POST /portfolios/{portfolio_id}/share Share a portfolio with one or more groups with specific permission
    @ManageiqCatalogApiJsclient.AdminsApi showOrderItem GET /orders/{order_id}/order_items/{id} Gets an individual order item from a given order
    @ManageiqCatalogApiJsclient.AdminsApi showPortfolio GET /portfolios/{id} Get a specific portfolio
    @ManageiqCatalogApiJsclient.AdminsApi showPortfolioItem GET /portfolio_items/{id} Gets a specific portfolio item
    @ManageiqCatalogApiJsclient.AdminsApi submitOrder POST /orders/{order_id}/submit_order Submit a given order
    @ManageiqCatalogApiJsclient.AdminsApi unsharePortfolio POST /portfolios/{portfolio_id}/unshare Unshare a portfolio from one or more groups with specific permission
    @ManageiqCatalogApiJsclient.AdminsApi updatePortfolio PATCH /portfolios/{id} Edit an existing portfolio
    @ManageiqCatalogApiJsclient.DefaultApi updatePortfolioItem PATCH /portfolio_items/{id} Edit an existing portfolio item
    @ManageiqCatalogApiJsclient.UsersApi addToOrder POST /orders/{order_id}/order_items Add an order item to an order in pending state
    @ManageiqCatalogApiJsclient.UsersApi fetchPortfolioItemsWithPortfolio GET /portfolios/{portfolio_id}/portfolio_items Get all portfolio items from a specific portfolio
    @ManageiqCatalogApiJsclient.UsersApi listOrderItems GET /orders/{order_id}/order_items Gets a list of items in a given order
    @ManageiqCatalogApiJsclient.UsersApi listOrders GET /orders Get a list of orders
    @ManageiqCatalogApiJsclient.UsersApi listPortfolioItems GET /portfolio_items List all portfolio items
    @ManageiqCatalogApiJsclient.UsersApi listPortfolios GET /portfolios List portfolios
    @ManageiqCatalogApiJsclient.UsersApi listProgressMessages GET /order_items/{order_item_id}/progress_messages Gets a list of progress messages in an item
    @ManageiqCatalogApiJsclient.UsersApi listProviderControlParameters GET /portfolio_items/{portfolio_item_id}/provider_control_parameters Gets the provider control parameters for this portfolio item; requires control paramaters provided when provisioning the portfolio item.
    @ManageiqCatalogApiJsclient.UsersApi listServicePlans GET /portfolio_items/{portfolio_item_id}/service_plans Gets all service plans for a specific portfolio item; requires a connection to the topology service.
    @ManageiqCatalogApiJsclient.UsersApi shareInfo GET /portfolios/{portfolio_id}/share_info Fetch share information about this portfolio, the response would include a collection of groups and permissions with each group
    @ManageiqCatalogApiJsclient.UsersApi showOrderItem GET /orders/{order_id}/order_items/{id} Gets an individual order item from a given order
    @ManageiqCatalogApiJsclient.UsersApi showPortfolio GET /portfolios/{id} Get a specific portfolio
    @ManageiqCatalogApiJsclient.UsersApi showPortfolioItem GET /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

    Keywords

    none

    Install

    npm i @manageiq/catalog-api-jsclient

    DownloadsWeekly Downloads

    2

    Version

    1.0.0

    License

    Apache 2.0

    Unpacked Size

    98.9 kB

    Total Files

    3

    Last publish

    Collaborators

    • h-kataria
    • fryguy
    • chessbyte
    • miq-bot
    • himdel
    • skateman
    • mzazrivec