Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@redhat-cloud-services/catalog-client

Package Overview
Dependencies
Maintainers
3
Versions
136
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@redhat-cloud-services/catalog-client - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

README.md

54

doc/classes/adminsapi.md

@@ -69,3 +69,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [AdminsApi](../classes/adminsapi.md)

*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L49)*
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L49)*

@@ -94,3 +94,3 @@ **Parameters:**

*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L51)*
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L51)*

@@ -106,3 +106,3 @@ ___

*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L51)*
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L51)*

@@ -118,3 +118,3 @@ ___

*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L49)*
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L49)*

@@ -131,3 +131,3 @@ ___

*Defined in [api.ts:2535](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2535)*
*Defined in [api.ts:2535](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2535)*

@@ -159,3 +159,3 @@ Adds a new portfolio item to an existing portfolio.

*Defined in [api.ts:2548](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2548)*
*Defined in [api.ts:2548](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2548)*

@@ -187,3 +187,3 @@ Adds an order item to an order in pending state

*Defined in [api.ts:2559](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2559)*
*Defined in [api.ts:2559](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2559)*

@@ -213,3 +213,3 @@ Creates a new order.

*Defined in [api.ts:2571](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2571)*
*Defined in [api.ts:2571](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2571)*

@@ -240,3 +240,3 @@ Adds a portfolio.

*Defined in [api.ts:2583](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2583)*
*Defined in [api.ts:2583](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2583)*

@@ -267,3 +267,3 @@ Adds a name and description for a portfolio item and returns the newly created portfolio item.

*Defined in [api.ts:2595](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2595)*
*Defined in [api.ts:2595](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2595)*

@@ -294,3 +294,3 @@ Deletes the portfolio specified by the ID.

*Defined in [api.ts:2607](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2607)*
*Defined in [api.ts:2607](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2607)*

@@ -321,3 +321,3 @@ Deletes the portfolio item based on portfolio item ID passed

*Defined in [api.ts:2621](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2621)*
*Defined in [api.ts:2621](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2621)*

@@ -350,3 +350,3 @@ Gets all portfilio items in the portfolio specified by the given ID.

*Defined in [api.ts:2635](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2635)*
*Defined in [api.ts:2635](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2635)*

@@ -379,3 +379,3 @@ Gets a list of items associated with an order.

*Defined in [api.ts:2648](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2648)*
*Defined in [api.ts:2648](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2648)*

@@ -407,3 +407,3 @@ Gets a list of orders associated with the logged in user.

*Defined in [api.ts:2661](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2661)*
*Defined in [api.ts:2661](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2661)*

@@ -435,3 +435,3 @@ Gets a list of portfolio items.

*Defined in [api.ts:2674](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2674)*
*Defined in [api.ts:2674](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2674)*

@@ -463,3 +463,3 @@ Gets a list of portfolios.

*Defined in [api.ts:2688](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2688)*
*Defined in [api.ts:2688](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2688)*

@@ -492,3 +492,3 @@ Gets a list of progress messages associated with an order item. As the item is being processed the provider can update the progress messages.

*Defined in [api.ts:2700](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2700)*
*Defined in [api.ts:2700](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2700)*

@@ -519,3 +519,3 @@ Gets the provider control parameters for a portfolio item.

*Defined in [api.ts:2712](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2712)*
*Defined in [api.ts:2712](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2712)*

@@ -546,3 +546,3 @@ Gets all service plans for a portfolio item.

*Defined in [api.ts:2724](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2724)*
*Defined in [api.ts:2724](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2724)*

@@ -573,3 +573,3 @@ Fetch share information about a portfolio

*Defined in [api.ts:2737](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2737)*
*Defined in [api.ts:2737](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2737)*

@@ -601,3 +601,3 @@ Share a Portfolio with one or more groups with specific permissions

*Defined in [api.ts:2750](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2750)*
*Defined in [api.ts:2750](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2750)*

@@ -629,3 +629,3 @@ Gets an order item associated with an order.

*Defined in [api.ts:2762](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2762)*
*Defined in [api.ts:2762](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2762)*

@@ -656,3 +656,3 @@ Gets the portfolio specified by the portfolio ID.

*Defined in [api.ts:2774](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2774)*
*Defined in [api.ts:2774](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2774)*

@@ -683,3 +683,3 @@ Gets a specific portfolio item based on the portfolio item ID passed

*Defined in [api.ts:2786](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2786)*
*Defined in [api.ts:2786](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2786)*

@@ -710,3 +710,3 @@ Returns an updated order.

*Defined in [api.ts:2799](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2799)*
*Defined in [api.ts:2799](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2799)*

@@ -738,3 +738,3 @@ Unshare a Portfolio with one or more groups with specific permissions

*Defined in [api.ts:2812](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2812)*
*Defined in [api.ts:2812](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2812)*

@@ -741,0 +741,0 @@ Returns the edited portfolio.

@@ -41,3 +41,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [BaseAPI](../classes/baseapi.md)

*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L49)*
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L49)*

@@ -64,3 +64,3 @@ **Parameters:**

*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L51)*
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L51)*

@@ -74,3 +74,3 @@ ___

*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L51)*
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L51)*

@@ -84,5 +84,5 @@ ___

*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L49)*
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L49)*
___

@@ -34,3 +34,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [Configuration](../classes/configuration.md)

*Defined in [configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L65)*
*Defined in [configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L65)*

@@ -55,3 +55,3 @@ **Parameters:**

*Defined in [configuration.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L51)*
*Defined in [configuration.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L51)*

@@ -73,3 +73,3 @@ parameter for oauth2 security

*Defined in [configuration.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L30)*
*Defined in [configuration.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L30)*

@@ -89,3 +89,3 @@ parameter for apiKey security

*Defined in [configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L65)*
*Defined in [configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L65)*

@@ -105,3 +105,3 @@ base options for axios calls

*Defined in [configuration.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L58)*
*Defined in [configuration.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L58)*

@@ -121,3 +121,3 @@ override base path

*Defined in [configuration.ts:44](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L44)*
*Defined in [configuration.ts:44](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L44)*

@@ -137,3 +137,3 @@ parameter for basic security

*Defined in [configuration.ts:37](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L37)*
*Defined in [configuration.ts:37](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L37)*

@@ -140,0 +140,0 @@ parameter for basic security

@@ -47,3 +47,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [DefaultApi](../classes/defaultapi.md)

*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L49)*
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L49)*

@@ -72,3 +72,3 @@ **Parameters:**

*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L51)*
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L51)*

@@ -84,3 +84,3 @@ ___

*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L51)*
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L51)*

@@ -96,3 +96,3 @@ ___

*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L49)*
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L49)*

@@ -109,3 +109,3 @@ ___

*Defined in [api.ts:2943](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2943)*
*Defined in [api.ts:2943](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2943)*

@@ -112,0 +112,0 @@ Edits portfolio item specified by the given ID.

@@ -41,3 +41,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [RequiredError](../classes/requirederror.md)

*Defined in [api.ts:66](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L66)*
*Defined in [api.ts:66](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L66)*

@@ -63,3 +63,3 @@ **Parameters:**

*Defined in [api.ts:67](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L67)*
*Defined in [api.ts:67](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L67)*

@@ -86,3 +86,3 @@ ___

*Defined in [api.ts:66](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L66)*
*Defined in [api.ts:66](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L66)*

@@ -89,0 +89,0 @@ ___

@@ -59,3 +59,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [UsersApi](../classes/usersapi.md)

*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L49)*
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L49)*

@@ -84,3 +84,3 @@ **Parameters:**

*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L51)*
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L51)*

@@ -96,3 +96,3 @@ ___

*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L51)*
*Defined in [api.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L51)*

@@ -108,3 +108,3 @@ ___

*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L49)*
*Defined in [api.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L49)*

@@ -121,3 +121,3 @@ ___

*Defined in [api.ts:3994](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L3994)*
*Defined in [api.ts:3994](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L3994)*

@@ -149,3 +149,3 @@ Adds an order item to an order in pending state

*Defined in [api.ts:4008](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4008)*
*Defined in [api.ts:4008](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4008)*

@@ -178,3 +178,3 @@ Gets all portfilio items in the portfolio specified by the given ID.

*Defined in [api.ts:4022](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4022)*
*Defined in [api.ts:4022](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4022)*

@@ -207,3 +207,3 @@ Gets a list of items associated with an order.

*Defined in [api.ts:4035](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4035)*
*Defined in [api.ts:4035](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4035)*

@@ -235,3 +235,3 @@ Gets a list of orders associated with the logged in user.

*Defined in [api.ts:4048](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4048)*
*Defined in [api.ts:4048](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4048)*

@@ -263,3 +263,3 @@ Gets a list of portfolio items.

*Defined in [api.ts:4061](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4061)*
*Defined in [api.ts:4061](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4061)*

@@ -291,3 +291,3 @@ Gets a list of portfolios.

*Defined in [api.ts:4075](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4075)*
*Defined in [api.ts:4075](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4075)*

@@ -320,3 +320,3 @@ Gets a list of progress messages associated with an order item. As the item is being processed the provider can update the progress messages.

*Defined in [api.ts:4087](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4087)*
*Defined in [api.ts:4087](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4087)*

@@ -347,3 +347,3 @@ Gets the provider control parameters for a portfolio item.

*Defined in [api.ts:4099](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4099)*
*Defined in [api.ts:4099](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4099)*

@@ -374,3 +374,3 @@ Gets all service plans for a portfolio item.

*Defined in [api.ts:4111](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4111)*
*Defined in [api.ts:4111](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4111)*

@@ -401,3 +401,3 @@ Fetch share information about a portfolio

*Defined in [api.ts:4124](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4124)*
*Defined in [api.ts:4124](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4124)*

@@ -429,3 +429,3 @@ Gets an order item associated with an order.

*Defined in [api.ts:4136](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4136)*
*Defined in [api.ts:4136](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4136)*

@@ -456,3 +456,3 @@ Gets the portfolio specified by the portfolio ID.

*Defined in [api.ts:4148](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L4148)*
*Defined in [api.ts:4148](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L4148)*

@@ -459,0 +459,0 @@ Gets a specific portfolio item based on the portfolio item ID passed

@@ -28,3 +28,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [Order](../modules/order.md) > [StateEnum](../enums/order.stateenum.md)

*Defined in [api.ts:209](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L209)*
*Defined in [api.ts:209](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L209)*

@@ -38,3 +38,3 @@ ___

*Defined in [api.ts:206](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L206)*
*Defined in [api.ts:206](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L206)*

@@ -48,3 +48,3 @@ ___

*Defined in [api.ts:208](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L208)*
*Defined in [api.ts:208](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L208)*

@@ -58,5 +58,5 @@ ___

*Defined in [api.ts:207](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L207)*
*Defined in [api.ts:207](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L207)*
___

@@ -28,3 +28,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [OrderItem](../modules/orderitem.md) > [StateEnum](../enums/orderitem.stateenum.md)

*Defined in [api.ts:306](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L306)*
*Defined in [api.ts:306](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L306)*

@@ -38,3 +38,3 @@ ___

*Defined in [api.ts:303](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L303)*
*Defined in [api.ts:303](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L303)*

@@ -48,3 +48,3 @@ ___

*Defined in [api.ts:305](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L305)*
*Defined in [api.ts:305](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L305)*

@@ -58,5 +58,5 @@ ___

*Defined in [api.ts:304](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L304)*
*Defined in [api.ts:304](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L304)*
___

@@ -28,3 +28,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [ProgressMessage](../modules/progressmessage.md) > [LevelEnum](../enums/progressmessage.levelenum.md)

*Defined in [api.ts:609](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L609)*
*Defined in [api.ts:609](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L609)*

@@ -38,3 +38,3 @@ ___

*Defined in [api.ts:607](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L607)*
*Defined in [api.ts:607](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L607)*

@@ -48,3 +48,3 @@ ___

*Defined in [api.ts:606](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L606)*
*Defined in [api.ts:606](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L606)*

@@ -58,5 +58,5 @@ ___

*Defined in [api.ts:608](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L608)*
*Defined in [api.ts:608](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L608)*
___

@@ -29,3 +29,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [AddPortfolioItem](../interfaces/addportfolioitem.md)

*Defined in [api.ts:83](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L83)*
*Defined in [api.ts:83](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L83)*

@@ -32,0 +32,0 @@ This is the ID of the portfolio item object.

@@ -32,3 +32,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [CollectionLinks](../interfaces/collectionlinks.md)

*Defined in [api.ts:97](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L97)*
*Defined in [api.ts:97](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L97)*

@@ -48,3 +48,3 @@ The link to fetch the first group of items in the result set

*Defined in [api.ts:103](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L103)*
*Defined in [api.ts:103](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L103)*

@@ -64,3 +64,3 @@ The link to fetch the last group of items in the result set

*Defined in [api.ts:115](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L115)*
*Defined in [api.ts:115](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L115)*

@@ -80,3 +80,3 @@ The link to fetch the next group of items in the result set

*Defined in [api.ts:109](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L109)*
*Defined in [api.ts:109](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L109)*

@@ -83,0 +83,0 @@ The link to fetch the previous group of items in the result set

@@ -29,3 +29,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [CollectionMetadata](../interfaces/collectionmetadata.md)

*Defined in [api.ts:129](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L129)*
*Defined in [api.ts:129](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L129)*

@@ -32,0 +32,0 @@ Total number of items in the result set, of which only a subset is returned, defined by the QueryLimit parameter.

@@ -36,3 +36,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [ConfigurationParameters](../interfaces/configurationparameters.md)

*Defined in [configuration.ts:19](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L19)*
*Defined in [configuration.ts:19](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L19)*

@@ -46,3 +46,3 @@ ___

*Defined in [configuration.ts:16](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L16)*
*Defined in [configuration.ts:16](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L16)*

@@ -56,3 +56,3 @@ ___

*Defined in [configuration.ts:21](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L21)*
*Defined in [configuration.ts:21](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L21)*

@@ -66,3 +66,3 @@ ___

*Defined in [configuration.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L20)*
*Defined in [configuration.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L20)*

@@ -76,3 +76,3 @@ ___

*Defined in [configuration.ts:18](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L18)*
*Defined in [configuration.ts:18](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L18)*

@@ -86,5 +86,5 @@ ___

*Defined in [configuration.ts:17](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/configuration.ts#L17)*
*Defined in [configuration.ts:17](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/configuration.ts#L17)*
___

@@ -29,3 +29,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [CreatePortfolioItem](../interfaces/createportfolioitem.md)

*Defined in [api.ts:143](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L143)*
*Defined in [api.ts:143](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L143)*

@@ -32,0 +32,0 @@ The service offering ref should be retrieved from a call to the Topology Service.

@@ -31,3 +31,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [OrderItemsCollection](../interfaces/orderitemscollection.md)

*Defined in [api.ts:333](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L333)*
*Defined in [api.ts:333](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L333)*

@@ -45,3 +45,3 @@ *__type__*: {Array}

*Defined in [api.ts:327](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L327)*
*Defined in [api.ts:327](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L327)*

@@ -59,3 +59,3 @@ *__type__*: {CollectionLinks}

*Defined in [api.ts:321](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L321)*
*Defined in [api.ts:321](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L321)*

@@ -62,0 +62,0 @@ *__type__*: {CollectionMetadata}

@@ -31,3 +31,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [OrdersCollection](../interfaces/orderscollection.md)

*Defined in [api.ts:359](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L359)*
*Defined in [api.ts:359](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L359)*

@@ -45,3 +45,3 @@ *__type__*: {Array}

*Defined in [api.ts:353](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L353)*
*Defined in [api.ts:353](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L353)*

@@ -59,3 +59,3 @@ *__type__*: {CollectionLinks}

*Defined in [api.ts:347](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L347)*
*Defined in [api.ts:347](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L347)*

@@ -62,0 +62,0 @@ *__type__*: {CollectionMetadata}

@@ -29,3 +29,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [Organization](../interfaces/organization.md)

*Defined in [api.ts:373](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L373)*
*Defined in [api.ts:373](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L373)*

@@ -32,0 +32,0 @@ *__type__*: {string}

@@ -35,3 +35,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [Portfolio](../interfaces/portfolio.md)

*Defined in [api.ts:399](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L399)*
*Defined in [api.ts:399](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L399)*

@@ -49,3 +49,3 @@ *__type__*: {string}

*Defined in [api.ts:405](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L405)*
*Defined in [api.ts:405](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L405)*

@@ -63,3 +63,3 @@ *__type__*: {boolean}

*Defined in [api.ts:387](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L387)*
*Defined in [api.ts:387](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L387)*

@@ -77,3 +77,3 @@ *__type__*: {string}

*Defined in [api.ts:411](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L411)*
*Defined in [api.ts:411](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L411)*

@@ -91,3 +91,3 @@ *__type__*: {string}

*Defined in [api.ts:393](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L393)*
*Defined in [api.ts:393](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L393)*

@@ -105,3 +105,3 @@ *__type__*: {string}

*Defined in [api.ts:423](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L423)*
*Defined in [api.ts:423](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L423)*

@@ -119,3 +119,3 @@ *__type__*: {string}

*Defined in [api.ts:417](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L417)*
*Defined in [api.ts:417](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L417)*

@@ -122,0 +122,0 @@ *__type__*: {string}

@@ -41,3 +41,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [PortfolioItem](../interfaces/portfolioitem.md)

*Defined in [api.ts:455](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L455)*
*Defined in [api.ts:455](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L455)*

@@ -55,3 +55,3 @@ *__type__*: {string}

*Defined in [api.ts:473](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L473)*
*Defined in [api.ts:473](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L473)*

@@ -69,3 +69,3 @@ *__type__*: {string}

*Defined in [api.ts:485](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L485)*
*Defined in [api.ts:485](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L485)*

@@ -83,3 +83,3 @@ *__type__*: {string}

*Defined in [api.ts:491](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L491)*
*Defined in [api.ts:491](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L491)*

@@ -97,3 +97,3 @@ *__type__*: {string}

*Defined in [api.ts:443](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L443)*
*Defined in [api.ts:443](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L443)*

@@ -111,3 +111,3 @@ *__type__*: {boolean}

*Defined in [api.ts:437](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L437)*
*Defined in [api.ts:437](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L437)*

@@ -125,3 +125,3 @@ *__type__*: {string}

*Defined in [api.ts:479](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L479)*
*Defined in [api.ts:479](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L479)*

@@ -139,3 +139,3 @@ *__type__*: {string}

*Defined in [api.ts:449](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L449)*
*Defined in [api.ts:449](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L449)*

@@ -153,3 +153,3 @@ *__type__*: {string}

*Defined in [api.ts:461](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L461)*
*Defined in [api.ts:461](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L461)*

@@ -167,3 +167,3 @@ *__type__*: {boolean}

*Defined in [api.ts:509](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L509)*
*Defined in [api.ts:509](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L509)*

@@ -181,3 +181,3 @@ *__type__*: {string}

*Defined in [api.ts:467](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L467)*
*Defined in [api.ts:467](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L467)*

@@ -195,3 +195,3 @@ *__type__*: {string}

*Defined in [api.ts:497](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L497)*
*Defined in [api.ts:497](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L497)*

@@ -209,3 +209,3 @@ *__type__*: {string}

*Defined in [api.ts:503](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L503)*
*Defined in [api.ts:503](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L503)*

@@ -212,0 +212,0 @@ *__type__*: {string}

@@ -31,3 +31,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [PortfolioItemsCollection](../interfaces/portfolioitemscollection.md)

*Defined in [api.ts:535](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L535)*
*Defined in [api.ts:535](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L535)*

@@ -45,3 +45,3 @@ *__type__*: {Array}

*Defined in [api.ts:529](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L529)*
*Defined in [api.ts:529](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L529)*

@@ -59,3 +59,3 @@ *__type__*: {CollectionLinks}

*Defined in [api.ts:523](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L523)*
*Defined in [api.ts:523](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L523)*

@@ -62,0 +62,0 @@ *__type__*: {CollectionMetadata}

@@ -31,3 +31,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [PortfoliosCollection](../interfaces/portfolioscollection.md)

*Defined in [api.ts:561](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L561)*
*Defined in [api.ts:561](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L561)*

@@ -45,3 +45,3 @@ *__type__*: {Array}

*Defined in [api.ts:555](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L555)*
*Defined in [api.ts:555](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L555)*

@@ -59,3 +59,3 @@ *__type__*: {CollectionLinks}

*Defined in [api.ts:549](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L549)*
*Defined in [api.ts:549](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L549)*

@@ -62,0 +62,0 @@ *__type__*: {CollectionMetadata}

@@ -31,3 +31,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [ProgressMessagesCollection](../interfaces/progressmessagescollection.md)

*Defined in [api.ts:636](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L636)*
*Defined in [api.ts:636](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L636)*

@@ -45,3 +45,3 @@ *__type__*: {Array}

*Defined in [api.ts:630](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L630)*
*Defined in [api.ts:630](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L630)*

@@ -59,3 +59,3 @@ *__type__*: {CollectionLinks}

*Defined in [api.ts:624](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L624)*
*Defined in [api.ts:624](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L624)*

@@ -62,0 +62,0 @@ *__type__*: {CollectionMetadata}

@@ -30,3 +30,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [RequestArgs](../interfaces/requestargs.md)

*Defined in [api.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L40)*
*Defined in [api.ts:40](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L40)*

@@ -40,5 +40,5 @@ ___

*Defined in [api.ts:39](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L39)*
*Defined in [api.ts:39](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L39)*
___

@@ -32,3 +32,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [ServicePlan](../interfaces/serviceplan.md)

*Defined in [api.ts:668](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L668)*
*Defined in [api.ts:668](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L668)*

@@ -48,3 +48,3 @@ JSON schema for the object.

*Defined in [api.ts:656](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L656)*
*Defined in [api.ts:656](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L656)*

@@ -64,3 +64,3 @@ The service plan description.

*Defined in [api.ts:662](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L662)*
*Defined in [api.ts:662](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L662)*

@@ -80,3 +80,3 @@ The unique identifier for this service plan.

*Defined in [api.ts:650](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L650)*
*Defined in [api.ts:650](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L650)*

@@ -83,0 +83,0 @@ The name of the service plan.

@@ -31,3 +31,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [ShareInfo](../interfaces/shareinfo.md)

*Defined in [api.ts:688](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L688)*
*Defined in [api.ts:688](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L688)*

@@ -47,3 +47,3 @@ The Group Name

*Defined in [api.ts:682](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L682)*
*Defined in [api.ts:682](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L682)*

@@ -63,3 +63,3 @@ The Group UUID

*Defined in [api.ts:694](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L694)*
*Defined in [api.ts:694](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L694)*

@@ -66,0 +66,0 @@ One or more permissions currently applied to this group.

@@ -30,3 +30,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [SharePolicy](../interfaces/sharepolicy.md)

*Defined in [api.ts:714](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L714)*
*Defined in [api.ts:714](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L714)*

@@ -46,3 +46,3 @@ An array of group UUID's retrieved from the RBAC Service with whom the resource has to be shared.

*Defined in [api.ts:708](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L708)*
*Defined in [api.ts:708](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L708)*

@@ -49,0 +49,0 @@ The permissions to apply for this share.

@@ -30,3 +30,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [UnsharePolicy](../interfaces/unsharepolicy.md)

*Defined in [api.ts:734](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L734)*
*Defined in [api.ts:734](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L734)*

@@ -46,3 +46,3 @@ An array of group UUID's retrieved from the RBAC Service from which the permissions have to be removed. If group uuids are not specified we will unshare it from all groups.

*Defined in [api.ts:728](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L728)*
*Defined in [api.ts:728](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L728)*

@@ -49,0 +49,0 @@ The permissions to remove for this resource.

@@ -35,3 +35,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [Order](../modules/order.md)

*Defined in [api.ts:187](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L187)*
*Defined in [api.ts:187](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L187)*

@@ -49,3 +49,3 @@ *__type__*: {Date}

*Defined in [api.ts:175](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L175)*
*Defined in [api.ts:175](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L175)*

@@ -63,3 +63,3 @@ *__type__*: {Date}

*Defined in [api.ts:157](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L157)*
*Defined in [api.ts:157](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L157)*

@@ -77,3 +77,3 @@ *__type__*: {string}

*Defined in [api.ts:181](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L181)*
*Defined in [api.ts:181](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L181)*

@@ -91,3 +91,3 @@ *__type__*: {Date}

*Defined in [api.ts:193](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L193)*
*Defined in [api.ts:193](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L193)*

@@ -105,3 +105,3 @@ *__type__*: {string}

*Defined in [api.ts:169](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L169)*
*Defined in [api.ts:169](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L169)*

@@ -121,3 +121,3 @@ Current State of the order.

*Defined in [api.ts:163](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L163)*
*Defined in [api.ts:163](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L163)*

@@ -124,0 +124,0 @@ *__type__*: {string}

@@ -40,3 +40,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [OrderItem](../modules/orderitem.md)

*Defined in [api.ts:278](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L278)*
*Defined in [api.ts:278](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L278)*

@@ -54,3 +54,3 @@ *__type__*: {Date}

*Defined in [api.ts:230](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L230)*
*Defined in [api.ts:230](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L230)*

@@ -68,3 +68,3 @@ *__type__*: {number}

*Defined in [api.ts:266](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L266)*
*Defined in [api.ts:266](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L266)*

@@ -82,3 +82,3 @@ *__type__*: {Date}

*Defined in [api.ts:224](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L224)*
*Defined in [api.ts:224](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L224)*

@@ -96,3 +96,3 @@ *__type__*: {string}

*Defined in [api.ts:272](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L272)*
*Defined in [api.ts:272](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L272)*

@@ -110,3 +110,3 @@ *__type__*: {Date}

*Defined in [api.ts:290](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L290)*
*Defined in [api.ts:290](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L290)*

@@ -124,3 +124,3 @@ *__type__*: {string}

*Defined in [api.ts:254](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L254)*
*Defined in [api.ts:254](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L254)*

@@ -140,3 +140,3 @@ Stores the Portfolio Item ID.

*Defined in [api.ts:242](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L242)*
*Defined in [api.ts:242](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L242)*

@@ -156,3 +156,3 @@ The provider specific parameters needed to provision this service. This might include namespaces, special keys.

*Defined in [api.ts:236](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L236)*
*Defined in [api.ts:236](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L236)*

@@ -170,3 +170,3 @@ *__type__*: {any}

*Defined in [api.ts:248](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L248)*
*Defined in [api.ts:248](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L248)*

@@ -186,3 +186,3 @@ Stores the service plan ref from the Topology Service.

*Defined in [api.ts:260](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L260)*
*Defined in [api.ts:260](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L260)*

@@ -202,3 +202,3 @@ Current state of this order item.

*Defined in [api.ts:284](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L284)*
*Defined in [api.ts:284](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L284)*

@@ -205,0 +205,0 @@ *__type__*: {Date}

@@ -32,3 +32,3 @@ [@redhat-cloud-services/catalog-client](../README.md) > [ProgressMessage](../modules/progressmessage.md)

*Defined in [api.ts:581](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L581)*
*Defined in [api.ts:581](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L581)*

@@ -46,3 +46,3 @@ *__type__*: {string}

*Defined in [api.ts:587](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L587)*
*Defined in [api.ts:587](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L587)*

@@ -60,3 +60,3 @@ *__type__*: {string}

*Defined in [api.ts:593](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L593)*
*Defined in [api.ts:593](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L593)*

@@ -74,3 +74,3 @@ *__type__*: {string}

*Defined in [api.ts:575](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L575)*
*Defined in [api.ts:575](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L575)*

@@ -77,0 +77,0 @@ *__type__*: {Date}

javascript-clients
==================
Javascript client for Catalog API
=================================
Javascript clients for swagger API
If you want to use [ManageIQ/catalog-api](https://github.com/ManageIQ/catalog-api) you shouldn't use get requests directly, but rather use this client to integrate with this service.
Install
-------
NPM
```bash
npm install --save @redhat-cloud-services/catalog-client
```
Or Yarn
```bash
yarn add @redhat-cloud-services/catalog-client
```
### Usage
This client is using typescript and axios. Types are distributed with this package, so no need to define or install them separately.
To correctly bootstrap this API you should use this config (no need to define it multiple times, just one config and reimport it anywhere you want to use it).
```JS
// api.js
import axios from 'axios';
import { AdminsApi } from '@redhat-cloud-services/catalog-client';
const instance = axios.create();
// BASE_PATH should be set in your constants file
const adminsApi = new AdminsApi(undefined, BASE_PATH, instance);
export adminsApi;
```
If you want to add some interceptors you can use axios build in interceptors
```JS
// api.js
import axios from 'axios';
import { AdminsApi } from '@redhat-cloud-services/catalog-client';
const instance = axios.create();
// Request interceptor
instance.interceptors.request.use((request) => {
// some logic to do with request
});
// Response interceptor
instance.interceptors.response.use((response) => {
// some logic to do with request
});
// Error interceptor
instance.interceptors.response.use(null, (error) => {
// some logic to do with error
});
// BASE_PATH should be set in your constants file
const adminsApi = new AdminsApi(undefined, BASE_PATH, instance);
export adminsApi;
```
API documentation
-----------------
* [README](doc/README.md)
## Index

@@ -75,3 +140,3 @@

*Defined in [api.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L20)*
*Defined in [api.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L20)*

@@ -88,3 +153,3 @@ ___

*Defined in [api.ts:742](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L742)*
*Defined in [api.ts:742](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L742)*

@@ -108,3 +173,3 @@ AdminsApi - axios parameter creator

*Defined in [api.ts:2270](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2270)*
*Defined in [api.ts:2270](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2270)*

@@ -130,3 +195,3 @@ AdminsApi - factory interface

*Defined in [api.ts:1925](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L1925)*
*Defined in [api.ts:1925](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L1925)*

@@ -150,3 +215,3 @@ AdminsApi - functional programming interface

*Defined in [api.ts:2822](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2822)*
*Defined in [api.ts:2822](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2822)*

@@ -170,3 +235,3 @@ DefaultApi - axios parameter creator

*Defined in [api.ts:2911](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2911)*
*Defined in [api.ts:2911](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2911)*

@@ -192,3 +257,3 @@ DefaultApi - factory interface

*Defined in [api.ts:2887](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2887)*
*Defined in [api.ts:2887](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2887)*

@@ -212,3 +277,3 @@ DefaultApi - functional programming interface

*Defined in [api.ts:2953](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L2953)*
*Defined in [api.ts:2953](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L2953)*

@@ -232,3 +297,3 @@ UsersApi - axios parameter creator

*Defined in [api.ts:3832](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L3832)*
*Defined in [api.ts:3832](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L3832)*

@@ -254,3 +319,3 @@ UsersApi - factory interface

*Defined in [api.ts:3630](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L3630)*
*Defined in [api.ts:3630](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L3630)*

@@ -277,3 +342,3 @@ UsersApi - functional programming interface

*Defined in [api.ts:26](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L26)*
*Defined in [api.ts:26](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L26)*

@@ -288,3 +353,3 @@ *__export__*:

*Defined in [api.ts:27](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L27)*
*Defined in [api.ts:27](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L27)*

@@ -298,3 +363,3 @@ ___

*Defined in [api.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L30)*
*Defined in [api.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L30)*

@@ -308,3 +373,3 @@ ___

*Defined in [api.ts:28](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L28)*
*Defined in [api.ts:28](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L28)*

@@ -318,3 +383,3 @@ ___

*Defined in [api.ts:29](https://github.com/RedHatInsights/javascript-clients/blob/7784268/packages/catalog/api.ts#L29)*
*Defined in [api.ts:29](https://github.com/RedHatInsights/javascript-clients/blob/0a2bbfb/packages/catalog/api.ts#L29)*

@@ -321,0 +386,0 @@ ___

{
"name": "@redhat-cloud-services/catalog-client",
"version": "1.0.2",
"version": "1.0.3",
"description": "",

@@ -5,0 +5,0 @@ "main": "dist/index.js",

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc