| 1 | import type { GetAppActionCallDetailsParams, GetAppActionCallParams } from '../../common-types';
|
| 2 | import type { AppActionCallProps, AppActionCallResponse, CreateAppActionCallProps } from '../../entities/app-action-call';
|
| 3 | import type { OptionalDefaults } from '../wrappers/wrap';
|
| 4 | export type AppActionCallPlainClientAPI = {
|
| 5 | /**
|
| 6 | * Calls (triggers) an App Action
|
| 7 | * @param params entity IDs to identify the App Action to call
|
| 8 | * @param payload the payload to be sent to the App Action
|
| 9 | * @returns basic metadata about the App Action Call
|
| 10 | * @throws if the request fails, or the App Action is not found
|
| 11 | * @example
|
| 12 | * ```javascript
|
| 13 | * await client.appActionCall.create(
|
| 14 | * {
|
| 15 | * spaceId: "<space_id>",
|
| 16 | * environmentId: "<environment_id>",
|
| 17 | * appDefinitionId: "<app_definition_id>",
|
| 18 | * appActionId: "<app_action_id>",
|
| 19 | * },
|
| 20 | * {
|
| 21 | * parameters: { // ... },
|
| 22 | * }
|
| 23 | * );
|
| 24 | * ```
|
| 25 | */
|
| 26 | create(params: OptionalDefaults<GetAppActionCallParams>, payload: CreateAppActionCallProps): Promise<AppActionCallProps>;
|
| 27 | /**
|
| 28 | * Fetches the details of an App Action Call
|
| 29 | * @param params entity IDs to identify the App Action Call
|
| 30 | * @returns detailed metadata about the App Action Call
|
| 31 | * @throws if the request fails, or the App Action is not found
|
| 32 | * @example
|
| 33 | * ```javascript
|
| 34 | * const appActionCall = await client.appActionCall.getCallDetails({
|
| 35 | * spaceId: "<space_id>",
|
| 36 | * environmentId: "<environment_id>",
|
| 37 | * appDefinitionId: "<app_definition_id>",
|
| 38 | * appActionId: "<app_action_id>",
|
| 39 | * });
|
| 40 | * ```
|
| 41 | */
|
| 42 | getCallDetails(params: OptionalDefaults<GetAppActionCallDetailsParams>): Promise<AppActionCallResponse>;
|
| 43 | /**
|
| 44 | * Calls (triggers) an App Action
|
| 45 | * @param params entity IDs to identify the App Action to call
|
| 46 | * @param payload the payload to be sent to the App Action
|
| 47 | * @returns detailed metadata about the App Action Call
|
| 48 | * @throws if the request fails, or the App Action is not found
|
| 49 | * @example
|
| 50 | * ```javascript
|
| 51 | * const appActionCall = await client.appActionCall.createWithResponse(
|
| 52 | * {
|
| 53 | * spaceId: "<space_id>",
|
| 54 | * environmentId: "<environment_id>",
|
| 55 | * appDefinitionId: "<app_definition_id>",
|
| 56 | * appActionId: "<app_action_id>",
|
| 57 | * },
|
| 58 | * {
|
| 59 | * parameters: { // ... },
|
| 60 | * }
|
| 61 | * );
|
| 62 | * ```
|
| 63 | */
|
| 64 | createWithResponse(params: OptionalDefaults<GetAppActionCallParams>, payload: CreateAppActionCallProps): Promise<AppActionCallResponse>;
|
| 65 | };
|