Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add integrations and notifications client #206

Closed
wants to merge 4 commits into from
Closed

Add integrations and notifications client #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
845d693
Add integrations-client
fhlavac Aug 31, 2023
97aa358
Add notifications-client
fhlavac Aug 31, 2023
79dc7da
Update all clients
fhlavac Aug 31, 2023
45c8b14
Update README
fhlavac Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
63 changes: 49 additions & 14 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions packages/approval/doc/classes/ActionApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ BaseAPI.configuration

### createAction

▸ **createAction**(`requestId`, `action`, `options?`): `Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md)\>\>
▸ **createAction**(`requestId`, `action`, `options?`): `Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md), `any`\>\>

Create an action under a request identified by its id. Admin can create approve, deny, memo, and cancel operations; approver can create approve, deny, and memo operations; while requester can create only cancel operation.

Expand All @@ -122,7 +122,7 @@ ActionApi

#### Returns

`Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md)\>\>
`Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md), `any`\>\>

#### Defined in

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

### listActionsByRequest

▸ **listActionsByRequest**(`requestId`, `options?`): `Promise`<`AxiosResponse`<[`ActionCollection`](../interfaces/ActionCollection.md)\>\>
▸ **listActionsByRequest**(`requestId`, `options?`): `Promise`<`AxiosResponse`<[`ActionCollection`](../interfaces/ActionCollection.md), `any`\>\>

Find actions of a request identified by its id, available to everyone

Expand All @@ -155,7 +155,7 @@ ActionApi

#### Returns

`Promise`<`AxiosResponse`<[`ActionCollection`](../interfaces/ActionCollection.md)\>\>
`Promise`<`AxiosResponse`<[`ActionCollection`](../interfaces/ActionCollection.md), `any`\>\>

#### Defined in

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

### showAction

▸ **showAction**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md)\>\>
▸ **showAction**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md), `any`\>\>

Find an action by its id, available to everyone

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

#### Returns

`Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md)\>\>
`Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md), `any`\>\>

#### Defined in

Expand Down
4 changes: 2 additions & 2 deletions packages/approval/doc/classes/DefaultApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ BaseAPI.configuration

### getDocumentation

▸ **getDocumentation**(`options?`): `Promise`<`AxiosResponse`<`object`\>\>
▸ **getDocumentation**(`options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\>

**`Summary`**

Expand All @@ -116,7 +116,7 @@ DefaultApi

#### Returns

`Promise`<`AxiosResponse`<`object`\>\>
`Promise`<`AxiosResponse`<`object`, `any`\>\>

#### Defined in

Expand Down
4 changes: 2 additions & 2 deletions packages/approval/doc/classes/GraphqlApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ BaseAPI.configuration

### postGraphql

▸ **postGraphql**(`graphqlIn`, `options?`): `Promise`<`AxiosResponse`<[`GraphqlOut`](../interfaces/GraphqlOut.md)\>\>
▸ **postGraphql**(`graphqlIn`, `options?`): `Promise`<`AxiosResponse`<[`GraphqlOut`](../interfaces/GraphqlOut.md), `any`\>\>

Perform a GraphQL query

Expand All @@ -119,7 +119,7 @@ GraphqlApi

#### Returns

`Promise`<`AxiosResponse`<[`GraphqlOut`](../interfaces/GraphqlOut.md)\>\>
`Promise`<`AxiosResponse`<[`GraphqlOut`](../interfaces/GraphqlOut.md), `any`\>\>

#### Defined in

Expand Down
20 changes: 10 additions & 10 deletions packages/approval/doc/classes/RequestApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ BaseAPI.configuration

### createRequest

▸ **createRequest**(`requestIn`, `options?`): `Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md)\>\>
▸ **createRequest**(`requestIn`, `options?`): `Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md), `any`\>\>

Create an approval request using given parameters, available to everyone

Expand All @@ -123,7 +123,7 @@ RequestApi

#### Returns

`Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md)\>\>
`Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md), `any`\>\>

#### Defined in

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

### listRequests

▸ **listRequests**(`xRhPersona?`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md)\>\>
▸ **listRequests**(`xRhPersona?`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md), `any`\>\>

The result depends on the x-rh-persona header (approval/admin, approval/requester, or approval/approver). Program generated child requests are not included.

Expand All @@ -160,7 +160,7 @@ RequestApi

#### Returns

`Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md)\>\>
`Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md), `any`\>\>

#### Defined in

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

### listRequestsByRequest

▸ **listRequestsByRequest**(`requestId`, `xRhPersona?`, `options?`): `Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md)\>\>
▸ **listRequestsByRequest**(`requestId`, `xRhPersona?`, `options?`): `Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md), `any`\>\>

Find child requests based on the parent request id. The result depends on the x-rh-persona header (approval/admin, approval/requester, or approval/approver).

Expand All @@ -194,7 +194,7 @@ RequestApi

#### Returns

`Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md)\>\>
`Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md), `any`\>\>

#### Defined in

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

### showRequest

▸ **showRequest**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md)\>\>
▸ **showRequest**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md), `any`\>\>

Find an approval request by its id, available to anyone who can access the request

Expand All @@ -227,7 +227,7 @@ RequestApi

#### Returns

`Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md)\>\>
`Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md), `any`\>\>

#### Defined in

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

### showRequestContent

▸ **showRequestContent**(`requestId`, `options?`): `Promise`<`AxiosResponse`<`object`\>\>
▸ **showRequestContent**(`requestId`, `options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\>

Find the request content based on a request id, available to everyone

Expand All @@ -260,7 +260,7 @@ RequestApi

#### Returns

`Promise`<`AxiosResponse`<`object`\>\>
`Promise`<`AxiosResponse`<`object`, `any`\>\>

#### Defined in

Expand Down
Loading