Skip to content

Commit

Permalink
Merge pull request #12 from Hyperkid123/sources-api-client
Browse files Browse the repository at this point in the history
Added client for sources API.
  • Loading branch information
karelhala authored Apr 17, 2019
2 parents 5c19545 + 9098080 commit 6e532cb
Show file tree
Hide file tree
Showing 90 changed files with 6,852 additions and 294 deletions.
20 changes: 6 additions & 14 deletions packages/catalog/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,12 @@ export interface OrderItem {
* @memberof OrderItem
*/
owner?: string;
/**
* The external url of the service instance used with relation to this order item
* @type {string}
* @memberof OrderItem
*/
externalUrl?: string;
}

/**
Expand Down Expand Up @@ -447,20 +453,6 @@ export interface OrdersCollection {
data?: Array<Order>;
}

/**
*
* @export
* @interface Organization
*/
export interface Organization {
/**
*
* @type {string}
* @memberof Organization
*/
id?: string;
}

/**
*
* @export
Expand Down
25 changes: 12 additions & 13 deletions packages/catalog/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ API documentation
* [CreatePortfolioItem](interfaces/createportfolioitem.md)
* [OrderItemsCollection](interfaces/orderitemscollection.md)
* [OrdersCollection](interfaces/orderscollection.md)
* [Organization](interfaces/organization.md)
* [Portfolio](interfaces/portfolio.md)
* [PortfolioItem](interfaces/portfolioitem.md)
* [PortfolioItemsCollection](interfaces/portfolioitemscollection.md)
Expand Down Expand Up @@ -156,7 +155,7 @@ ___

**OrderApiAxiosParamCreator**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:862](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L862)*
*Defined in [api.ts:854](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L854)*

OrderApi - axios parameter creator

Expand All @@ -175,7 +174,7 @@ ___

**OrderApiFactory**(configuration?: *[Configuration](classes/configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): `object`

*Defined in [api.ts:1225](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1225)*
*Defined in [api.ts:1217](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1217)*

OrderApi - factory interface

Expand All @@ -196,7 +195,7 @@ ___

**OrderApiFp**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:1128](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1128)*
*Defined in [api.ts:1120](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1120)*

OrderApi - functional programming interface

Expand All @@ -215,7 +214,7 @@ ___

**OrderItemApiAxiosParamCreator**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:1383](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1383)*
*Defined in [api.ts:1375](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1375)*

OrderItemApi - axios parameter creator

Expand All @@ -234,7 +233,7 @@ ___

**OrderItemApiFactory**(configuration?: *[Configuration](classes/configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): `object`

*Defined in [api.ts:1531](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1531)*
*Defined in [api.ts:1523](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1523)*

OrderItemApi - factory interface

Expand All @@ -255,7 +254,7 @@ ___

**OrderItemApiFp**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:1490](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1490)*
*Defined in [api.ts:1482](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1482)*

OrderItemApi - functional programming interface

Expand All @@ -274,7 +273,7 @@ ___

**PortfolioApiAxiosParamCreator**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:1601](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1601)*
*Defined in [api.ts:1593](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1593)*

PortfolioApi - axios parameter creator

Expand All @@ -293,7 +292,7 @@ ___

**PortfolioApiFactory**(configuration?: *[Configuration](classes/configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): `object`

*Defined in [api.ts:2209](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2209)*
*Defined in [api.ts:2201](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2201)*

PortfolioApi - factory interface

Expand All @@ -314,7 +313,7 @@ ___

**PortfolioApiFp**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:2053](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2053)*
*Defined in [api.ts:2045](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2045)*

PortfolioApi - functional programming interface

Expand All @@ -333,7 +332,7 @@ ___

**PortfolioItemApiAxiosParamCreator**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:2461](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2461)*
*Defined in [api.ts:2453](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2453)*

PortfolioItemApi - axios parameter creator

Expand All @@ -352,7 +351,7 @@ ___

**PortfolioItemApiFactory**(configuration?: *[Configuration](classes/configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): `object`

*Defined in [api.ts:2921](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2921)*
*Defined in [api.ts:2913](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2913)*

PortfolioItemApi - factory interface

Expand All @@ -373,7 +372,7 @@ ___

**PortfolioItemApiFp**(configuration?: *[Configuration](classes/configuration.md)*): `object`

*Defined in [api.ts:2798](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2798)*
*Defined in [api.ts:2790](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2790)*

PortfolioItemApi - functional programming interface

Expand Down
12 changes: 6 additions & 6 deletions packages/catalog/doc/classes/orderapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ ___

**addToOrder**(orderId: *`string`*, orderItem: *[OrderItem](../modules/orderitem.md)*, options?: *`any`*): `AxiosPromise`<`Response`>

*Defined in [api.ts:1310](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1310)*
*Defined in [api.ts:1302](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1302)*

Adds an order item to an order in pending state

Expand All @@ -134,7 +134,7 @@ ___

**createOrder**(options?: *`any`*): `AxiosPromise`<[Order](../modules/order.md)>

*Defined in [api.ts:1321](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1321)*
*Defined in [api.ts:1313](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1313)*

Creates a new order.

Expand All @@ -159,7 +159,7 @@ ___

**listOrderItems**(orderId: *`string`*, limit?: *`number`*, offset?: *`number`*, options?: *`any`*): `AxiosPromise`<[OrderItemsCollection](../interfaces/orderitemscollection.md)>

*Defined in [api.ts:1335](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1335)*
*Defined in [api.ts:1327](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1327)*

Gets a list of items associated with an order.

Expand Down Expand Up @@ -187,7 +187,7 @@ ___

**listOrders**(limit?: *`number`*, offset?: *`number`*, options?: *`any`*): `AxiosPromise`<[OrdersCollection](../interfaces/orderscollection.md)>

*Defined in [api.ts:1348](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1348)*
*Defined in [api.ts:1340](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1340)*

Gets a list of orders associated with the logged in user.

Expand All @@ -214,7 +214,7 @@ ___

**showOrderItem**(orderId: *`string`*, id: *`string`*, options?: *`any`*): `AxiosPromise`<[OrderItem](../modules/orderitem.md)>

*Defined in [api.ts:1361](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1361)*
*Defined in [api.ts:1353](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1353)*

Gets an order item associated with an order.

Expand All @@ -241,7 +241,7 @@ ___

**submitOrder**(orderId: *`string`*, options?: *`any`*): `AxiosPromise`<[Order](../modules/order.md)>

*Defined in [api.ts:1373](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1373)*
*Defined in [api.ts:1365](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1365)*

Returns an updated order.

Expand Down
4 changes: 2 additions & 2 deletions packages/catalog/doc/classes/orderitemapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ ___

**listApprovalRequests**(orderItemId: *`string`*, limit?: *`number`*, offset?: *`number`*, options?: *`any`*): `AxiosPromise`<[ApprovalRequestsCollection](../interfaces/approvalrequestscollection.md)>

*Defined in [api.ts:1577](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1577)*
*Defined in [api.ts:1569](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1569)*

Gets a list of approval request associated with an order item. As the item is being approved one can check the status of the approvals.

Expand Down Expand Up @@ -131,7 +131,7 @@ ___

**listProgressMessages**(orderItemId: *`string`*, limit?: *`number`*, offset?: *`number`*, options?: *`any`*): `AxiosPromise`<[ProgressMessagesCollection](../interfaces/progressmessagescollection.md)>

*Defined in [api.ts:1591](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1591)*
*Defined in [api.ts:1583](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L1583)*

Gets a list of progress messages associated with an order item. As the item is being processed the provider can update the progress messages.

Expand Down
20 changes: 10 additions & 10 deletions packages/catalog/doc/classes/portfolioapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ ___

**addPortfolioItemToPortfolio**(portfolioId: *`string`*, addPortfolioItem: *[AddPortfolioItem](../interfaces/addportfolioitem.md)*, options?: *`any`*): `AxiosPromise`<`Response`>

*Defined in [api.ts:2337](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2337)*
*Defined in [api.ts:2329](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2329)*

Adds a new portfolio item to an existing portfolio.

Expand All @@ -138,7 +138,7 @@ ___

**createPortfolio**(portfolio: *[Portfolio](../interfaces/portfolio.md)*, options?: *`any`*): `AxiosPromise`<[Portfolio](../interfaces/portfolio.md)>

*Defined in [api.ts:2349](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2349)*
*Defined in [api.ts:2341](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2341)*

Adds a portfolio.

Expand All @@ -164,7 +164,7 @@ ___

**destroyPortfolio**(id: *`string`*, options?: *`any`*): `AxiosPromise`<`Response`>

*Defined in [api.ts:2361](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2361)*
*Defined in [api.ts:2353](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2353)*

Deletes the portfolio specified by the ID.

Expand All @@ -190,7 +190,7 @@ ___

**fetchPortfolioItemsWithPortfolio**(portfolioId: *`string`*, limit?: *`number`*, offset?: *`number`*, options?: *`any`*): `AxiosPromise`<[PortfolioItemsCollection](../interfaces/portfolioitemscollection.md)>

*Defined in [api.ts:2375](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2375)*
*Defined in [api.ts:2367](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2367)*

Gets all portfilio items in the portfolio specified by the given ID.

Expand Down Expand Up @@ -218,7 +218,7 @@ ___

**listPortfolios**(limit?: *`number`*, offset?: *`number`*, options?: *`any`*): `AxiosPromise`<[PortfoliosCollection](../interfaces/portfolioscollection.md)>

*Defined in [api.ts:2388](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2388)*
*Defined in [api.ts:2380](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2380)*

Gets a list of portfolios.

Expand All @@ -245,7 +245,7 @@ ___

**shareInfo**(portfolioId: *`string`*, options?: *`any`*): `AxiosPromise`<[ShareInfo](../interfaces/shareinfo.md)[]>

*Defined in [api.ts:2400](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2400)*
*Defined in [api.ts:2392](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2392)*

Fetch share information about a portfolio

Expand All @@ -271,7 +271,7 @@ ___

**sharePortfolio**(portfolioId: *`string`*, sharePolicy: *[SharePolicy](../interfaces/sharepolicy.md)*, options?: *`any`*): `AxiosPromise`<`Response`>

*Defined in [api.ts:2413](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2413)*
*Defined in [api.ts:2405](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2405)*

Share a Portfolio with one or more groups with specific permissions

Expand All @@ -298,7 +298,7 @@ ___

**showPortfolio**(id: *`string`*, options?: *`any`*): `AxiosPromise`<[Portfolio](../interfaces/portfolio.md)>

*Defined in [api.ts:2425](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2425)*
*Defined in [api.ts:2417](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2417)*

Gets the portfolio specified by the portfolio ID.

Expand All @@ -324,7 +324,7 @@ ___

**unsharePortfolio**(portfolioId: *`string`*, unsharePolicy: *[UnsharePolicy](../interfaces/unsharepolicy.md)*, options?: *`any`*): `AxiosPromise`<`Response`>

*Defined in [api.ts:2438](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2438)*
*Defined in [api.ts:2430](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2430)*

Unshare a Portfolio with one or more groups with specific permissions

Expand All @@ -351,7 +351,7 @@ ___

**updatePortfolio**(id: *`string`*, portfolio: *[Portfolio](../interfaces/portfolio.md)*, options?: *`any`*): `AxiosPromise`<[Portfolio](../interfaces/portfolio.md)>

*Defined in [api.ts:2451](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2451)*
*Defined in [api.ts:2443](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L2443)*

Returns the edited portfolio.

Expand Down
16 changes: 8 additions & 8 deletions packages/catalog/doc/classes/portfolioitemapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ ___

**createPortfolioItem**(createPortfolioItem: *[CreatePortfolioItem](../interfaces/createportfolioitem.md)*, options?: *`any`*): `AxiosPromise`<[PortfolioItem](../interfaces/portfolioitem.md)>

*Defined in [api.ts:3023](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3023)*
*Defined in [api.ts:3015](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3015)*

Adds a name and description for a portfolio item and returns the newly created portfolio item.

Expand All @@ -135,7 +135,7 @@ ___

**destroyPortfolioItem**(id: *`string`*, options?: *`any`*): `AxiosPromise`<`Response`>

*Defined in [api.ts:3035](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3035)*
*Defined in [api.ts:3027](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3027)*

Deletes the portfolio item based on portfolio item ID passed

Expand All @@ -161,7 +161,7 @@ ___

**listPortfolioItems**(limit?: *`number`*, offset?: *`number`*, options?: *`any`*): `AxiosPromise`<[PortfolioItemsCollection](../interfaces/portfolioitemscollection.md)>

*Defined in [api.ts:3048](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3048)*
*Defined in [api.ts:3040](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3040)*

Gets a list of portfolio items.

Expand All @@ -188,7 +188,7 @@ ___

**listProviderControlParameters**(portfolioItemId: *`string`*, options?: *`any`*): `AxiosPromise`<`any`>

*Defined in [api.ts:3060](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3060)*
*Defined in [api.ts:3052](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3052)*

Gets the provider control parameters for a portfolio item.

Expand All @@ -214,7 +214,7 @@ ___

**listServiceOfferingIcon**(portfolioItemId: *`string`*, options?: *`any`*): `AxiosPromise`<[ServiceOfferingIcon](../interfaces/serviceofferingicon.md)>

*Defined in [api.ts:3072](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3072)*
*Defined in [api.ts:3064](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3064)*

Fetch the specified portfolio item's icon information.

Expand All @@ -240,7 +240,7 @@ ___

**listServicePlans**(portfolioItemId: *`string`*, options?: *`any`*): `AxiosPromise`<[ServicePlan](../interfaces/serviceplan.md)[]>

*Defined in [api.ts:3084](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3084)*
*Defined in [api.ts:3076](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3076)*

Gets all service plans for a portfolio item.

Expand All @@ -266,7 +266,7 @@ ___

**showPortfolioItem**(id: *`string`*, options?: *`any`*): `AxiosPromise`<[PortfolioItem](../interfaces/portfolioitem.md)>

*Defined in [api.ts:3096](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3096)*
*Defined in [api.ts:3088](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3088)*

Gets a specific portfolio item based on the portfolio item ID passed

Expand All @@ -292,7 +292,7 @@ ___

**updatePortfolioItem**(id: *`string`*, portfolioItem: *[PortfolioItem](../interfaces/portfolioitem.md)*, options?: *`any`*): `AxiosPromise`<[PortfolioItem](../interfaces/portfolioitem.md)>

*Defined in [api.ts:3109](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3109)*
*Defined in [api.ts:3101](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/catalog/api.ts#L3101)*

Edits portfolio item specified by the given ID.

Expand Down
Loading

0 comments on commit 6e532cb

Please sign in to comment.