acquia-dam-sdk/dist/apis/orders/api.d.ts

Interact with the Acquia DAM API

import { ApiClient } from '../../client/index.js';
import { CreateOrderParams, GetOrderDetailsParams, ListConversionsForOrderParams } from './requests.js';
import { CleanAssetsResult, CreateOrderResult, GetOrderDetailsResult, GetZipStatusResult, ListConversionsForOrderResult, ListOrderProfileResult } from './responses.js';

declare class OrdersApi {
    private _client;
    /**
     * Create an instance of the OrdersApi class
     *
     * Provides information about Orders and Conversions
     *
     * @param client Provide an instance of ApiClient.
     */
    constructor(client: ApiClient);
    /**
     * This can be called before attempting to create an order to determine which items will be removed from the order. Situations include an asset that has been deleted or an asset the user does not have permission to order. Any items returned in the removedItems list, will be removed automatically when the order is submitted.
     * @param assets Array of asset UUIDs
     * @returns Promise containing the assets that will not be ordered
     * @see {@link https://widenv1.docs.apiary.io/#reference/orders/create-order/clean-assets-for-order}
     */
    cleanAssets(assets: string[]): Promise<CleanAssetsResult>;
    /**
     * Create an asset order.
     * @param params Information about the request
     * @returns Promise containing information about the created order
     * @see {@link https://widenv1.docs.apiary.io/#reference/orders/create-order/create-order}
     */
    createOrder(params: CreateOrderParams): Promise<CreateOrderResult>;
    /**
     * Used to submit a request to begin the creation of a zip archive for a specific order
     * @param uuid The order UUID
     * @returns Promise containing no information
     * @see {@link https://widenv1.docs.apiary.io/#reference/orders/zip-archives/create-zip-archive}
     */
    createZipArchive(uuid: string): Promise<void>;
    /**
     * Gets order information by uuid or sequence number and, if the order conversion status is 'Completed', up to 100 assets and associated conversions and pickup urls for that order. If the order conversion status is not 'Completed', only order details (uuid, conversion status, assets in order, and sequence number) will appear in the response.
     * @param params Information about the request
     * @returns Promise containing information about the order
     */
    getOrderDetails(params: GetOrderDetailsParams): Promise<GetOrderDetailsResult>;
    /**
     * Used to check the status of an archive operation that has previously been submitted. If the archive operation is complete, this call returns a download link for the zip archive.
     * @param uuid The order UUID
     * @returns Promise containing information about the status of the Zip archive
     * @see {@link https://widenv1.docs.apiary.io/#reference/orders/zip-archives/get-zip-archive-status/link}
     */
    getZipStatus(uuid: string): Promise<GetZipStatusResult>;
    /**
     * Retrieves the list of conversions available for a specific order profile and set of assets.
     * @param params Information about the request
     * @returns Promise containing the list of available conversions
     * @see {@link https://widenv1.docs.apiary.io/#reference/orders/conversions-for-order/conversions-for-order}
     */
    listConversionsForOrder(params: ListConversionsForOrderParams): Promise<ListConversionsForOrderResult>;
    /**
     * Gets the Order Profiles available for sending orders via the internet
     * @returns Promise containing the list of available order profiles
     * @see {@link https://widenv1.docs.apiary.io/#reference/orders/internet-order-profile-list/internet-order-profile-list}
     */
    listOrderProfiles(): Promise<ListOrderProfileResult>;
}

export { OrdersApi };