acquia-dam-sdk/dist/client/types.d.ts

Interact with the Acquia DAM API

/** Options for {@link ApiClient.sendRequest} */
interface ApiRequestParams {
    /** The version of the API being used */
    apiVersion: ApiVersions;
    /** The body of the request */
    body?: object;
    /** The HTTP method */
    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
    /** The path of the request, excluding the base URL */
    path: string;
    /** The query string parameters sent in the URL */
    queryStringParams?: object;
}
type ApiVersions = '1' | '2';
type ErrorTypes = 'SDK Error' | 'HTTP Error';

export type { ApiRequestParams, ApiVersions, ErrorTypes };