contentful-management
Version:
Client for Contentful's Content Management API
87 lines (86 loc) • 3.16 kB
TypeScript
import type { Except } from 'type-fest';
import type { BasicMetaSysProps, AppActionCallRetryOptions, DefaultElements, MakeRequest, SysLink, CreateWithResponseParams, CreateWithResultParams, GetAppActionCallDetailsParams, GetAppActionCallParamsWithId } from '../common-types';
import type { WebhookCallDetailsProps } from './webhook';
type AppActionCallSys = Except<BasicMetaSysProps, 'version'> & {
appDefinition: SysLink;
space: SysLink;
environment: SysLink;
action: SysLink;
appActionCallResponse?: SysLink;
};
type RetryOptions = AppActionCallRetryOptions;
export type AppActionCallStatus = 'processing' | 'succeeded' | 'failed';
export interface AppActionCallErrorProps {
sys: {
type: 'Error';
id: string;
};
message: string;
details?: Record<string, unknown>;
statusCode?: number;
}
export type AppActionCallProps = {
/**
* System metadata
*/
sys: AppActionCallSys;
/** The execution status of the app action call, if available */
status?: AppActionCallStatus;
/** Structured result when execution succeeded */
result?: unknown;
/** Structured error when execution failed */
error?: AppActionCallErrorProps;
};
export type CreateAppActionCallProps = {
/** The body for the call */
parameters: {
[key: string]: unknown;
};
};
type AppActionCallApi = {
createWithResponse(params: CreateWithResponseParams, payload: CreateAppActionCallProps): Promise<AppActionCallResponse>;
getCallDetails(params: GetAppActionCallDetailsParams): Promise<AppActionCallResponse>;
get(params: GetAppActionCallParamsWithId): Promise<AppActionCallProps>;
createWithResult(params: CreateWithResultParams, payload: CreateAppActionCallProps): Promise<AppActionCallProps>;
};
export type AppActionCallResponse = WebhookCallDetailsProps;
export interface AppActionCallRawResponseProps {
sys: {
id: string;
type: 'AppActionCallResponse';
space: SysLink;
environment: SysLink;
appInstallation: SysLink;
appAction: SysLink;
createdAt: string;
};
response: {
headers?: {
contentType?: string;
};
body: string;
};
}
export interface AppActionCallResponseData extends AppActionCallResponse, DefaultElements<AppActionCallResponse>, AppActionCallApi {
}
export interface AppActionCall extends AppActionCallProps, DefaultElements<AppActionCallProps> {
}
/**
* @private
*/
export default function createAppActionCallApi(makeRequest: MakeRequest, retryOptions?: RetryOptions): AppActionCallApi;
/**
* @private
* @param http - HTTP client instance
* @param data - Raw AppActionCall data
* @return Wrapped AppActionCall data
*/
export declare function wrapAppActionCall(makeRequest: MakeRequest, data: AppActionCallProps): AppActionCall;
/**
* @private
* @param http - HTTP client instance
* @param data - Raw AppActionCall data
* @return Wrapped AppActionCall data
*/
export declare function wrapAppActionCallResponse(makeRequest: MakeRequest, data: AppActionCallResponse, retryOptions?: RetryOptions): AppActionCallResponseData;
export {};