liferay-headless-rest-client/dist/clients/headless-commerce-delivery-order-v1.0/sdk.gen.d.ts

A collection of Headless Clients used in Liferay Portal

import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { DeletePlacedOrderAttachmentData, DeletePlacedOrderAttachmentResponses, DeletePlacedOrderByExternalReferenceCodeAttachmentByExternalReferenceCodeAttachmentExternalReferenceCodeData, DeletePlacedOrderByExternalReferenceCodeAttachmentByExternalReferenceCodeAttachmentExternalReferenceCodeResponses, GetPlacedOrderAttachmentsPageData, GetPlacedOrderAttachmentsPageResponses, GetPlacedOrderByExternalReferenceCodeAttachmentsPageData, GetPlacedOrderByExternalReferenceCodeAttachmentsPageResponses, PostPlacedOrderAttachmentByBase64Data, PostPlacedOrderAttachmentByBase64Responses, PostPlacedOrderAttachmentsPageExportBatchData, PostPlacedOrderAttachmentsPageExportBatchResponses, PostPlacedOrderByExternalReferenceCodeAttachmentByBase64Data, PostPlacedOrderByExternalReferenceCodeAttachmentByBase64Responses, GetPlacedOrderOrderTransitionsPageData, GetPlacedOrderOrderTransitionsPageResponses, PostPlacedOrderOrderTransitionData, PostPlacedOrderOrderTransitionResponses, PostPlacedOrderOrderTransitionBatchData, PostPlacedOrderOrderTransitionBatchResponses, PostPlacedOrderOrderTransitionsPageExportBatchData, PostPlacedOrderOrderTransitionsPageExportBatchResponses, GetPlacedOrderByExternalReferenceCodePlacedOrderBillingAddressData, GetPlacedOrderByExternalReferenceCodePlacedOrderBillingAddressResponses, GetPlacedOrderByExternalReferenceCodePlacedOrderShippingAddressData, GetPlacedOrderByExternalReferenceCodePlacedOrderShippingAddressResponses, GetPlacedOrderPlacedOrderBillingAddressData, GetPlacedOrderPlacedOrderBillingAddressResponses, GetPlacedOrderPlacedOrderShippingAddressData, GetPlacedOrderPlacedOrderShippingAddressResponses, GetPlacedOrderByExternalReferenceCodePlacedOrderCommentsPageData, GetPlacedOrderByExternalReferenceCodePlacedOrderCommentsPageResponses, GetPlacedOrderCommentData, GetPlacedOrderCommentResponses, GetPlacedOrderCommentByExternalReferenceCodeData, GetPlacedOrderCommentByExternalReferenceCodeResponses, GetPlacedOrderPlacedOrderCommentsPageData, GetPlacedOrderPlacedOrderCommentsPageResponses, PostPlacedOrderPlacedOrderCommentsPageExportBatchData, PostPlacedOrderPlacedOrderCommentsPageExportBatchResponses, GetPlacedOrderByExternalReferenceCodePlacedOrderItemsPageData, GetPlacedOrderByExternalReferenceCodePlacedOrderItemsPageResponses, GetPlacedOrderItemData, GetPlacedOrderItemResponses, GetPlacedOrderItemByExternalReferenceCodeData, GetPlacedOrderItemByExternalReferenceCodeResponses, GetPlacedOrderPlacedOrderItemsPageData, GetPlacedOrderPlacedOrderItemsPageResponses, PostPlacedOrderPlacedOrderItemsPageExportBatchData, PostPlacedOrderPlacedOrderItemsPageExportBatchResponses, GetPlacedOrderItemByExternalReferenceCodePlacedOrderItemShipmentsPageData, GetPlacedOrderItemByExternalReferenceCodePlacedOrderItemShipmentsPageResponses, GetPlacedOrderItemPlacedOrderItemShipmentsPageData, GetPlacedOrderItemPlacedOrderItemShipmentsPageResponses, PostPlacedOrderItemPlacedOrderItemShipmentsPageExportBatchData, PostPlacedOrderItemPlacedOrderItemShipmentsPageExportBatchResponses, GetChannelAccountPlacedOrdersPageData, GetChannelAccountPlacedOrdersPageResponses, GetChannelByExternalReferenceCodeChannelExternalReferenceCodeAccountByExternalReferenceCodeAccountExternalReferenceCodePlacedOrdersPageData, GetChannelByExternalReferenceCodeChannelExternalReferenceCodeAccountByExternalReferenceCodeAccountExternalReferenceCodePlacedOrdersPageResponses, GetChannelByExternalReferenceCodePlacedOrdersPageData, GetChannelByExternalReferenceCodePlacedOrdersPageResponses, GetChannelPlacedOrdersPageData, GetChannelPlacedOrdersPageResponses, GetPlacedOrderData, GetPlacedOrderResponses, PatchPlacedOrderData, PatchPlacedOrderResponses, GetPlacedOrderByExternalReferenceCodeData, GetPlacedOrderByExternalReferenceCodeResponses, PatchPlacedOrderByExternalReferenceCodeData, PatchPlacedOrderByExternalReferenceCodeResponses, GetPlacedOrderByExternalReferenceCodePaymentUrlData, GetPlacedOrderByExternalReferenceCodePaymentUrlResponses, GetPlacedOrderPaymentUrlData, GetPlacedOrderPaymentUrlResponses, GetPlacedOrderByExternalReferenceCodeShipmentsPageData, GetPlacedOrderByExternalReferenceCodeShipmentsPageResponses, GetPlacedOrderShipmentsPageData, GetPlacedOrderShipmentsPageResponses, PostPlacedOrderShipmentsPageExportBatchData, PostPlacedOrderShipmentsPageExportBatchResponses, GetPlacedOrderByExternalReferenceCodeDeliveryTermData, GetPlacedOrderByExternalReferenceCodeDeliveryTermResponses, GetPlacedOrderByExternalReferenceCodePaymentTermData, GetPlacedOrderByExternalReferenceCodePaymentTermResponses, GetPlacedOrderDeliveryTermData, GetPlacedOrderDeliveryTermResponses, GetPlacedOrderPaymentTermData, GetPlacedOrderPaymentTermResponses } from './types.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
    /**
     * You can provide a client instance returned by `createClient()` instead of
     * individual options. This might be also useful if you want to implement a
     * custom client.
     */
    client?: Client;
    /**
     * You can pass arbitrary values through the `meta` object. This can be
     * used to access values that aren't defined as part of the SDK function.
     */
    meta?: Record<string, unknown>;
};
export declare const deletePlacedOrderAttachment: <ThrowOnError extends boolean = false>(options: Options<DeletePlacedOrderAttachmentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePlacedOrderAttachmentResponses, unknown, ThrowOnError, "fields">;
export declare const deletePlacedOrderByExternalReferenceCodeAttachmentByExternalReferenceCodeAttachmentExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<DeletePlacedOrderByExternalReferenceCodeAttachmentByExternalReferenceCodeAttachmentExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeletePlacedOrderByExternalReferenceCodeAttachmentByExternalReferenceCodeAttachmentExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getPlacedOrderAttachmentsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderAttachmentsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderAttachmentsPageResponses, unknown, ThrowOnError, "fields">;
export declare const getPlacedOrderByExternalReferenceCodeAttachmentsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderByExternalReferenceCodeAttachmentsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderByExternalReferenceCodeAttachmentsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postPlacedOrderAttachmentByBase64: <ThrowOnError extends boolean = false>(options: Options<PostPlacedOrderAttachmentByBase64Data, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlacedOrderAttachmentByBase64Responses, unknown, ThrowOnError, "fields">;
export declare const postPlacedOrderAttachmentsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostPlacedOrderAttachmentsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlacedOrderAttachmentsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postPlacedOrderByExternalReferenceCodeAttachmentByBase64: <ThrowOnError extends boolean = false>(options: Options<PostPlacedOrderByExternalReferenceCodeAttachmentByBase64Data, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlacedOrderByExternalReferenceCodeAttachmentByBase64Responses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve order transitions of the given Placed Order.
 */
export declare const getPlacedOrderOrderTransitionsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderOrderTransitionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderOrderTransitionsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postPlacedOrderOrderTransition: <ThrowOnError extends boolean = false>(options: Options<PostPlacedOrderOrderTransitionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlacedOrderOrderTransitionResponses, unknown, ThrowOnError, "fields">;
export declare const postPlacedOrderOrderTransitionBatch: <ThrowOnError extends boolean = false>(options: Options<PostPlacedOrderOrderTransitionBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlacedOrderOrderTransitionBatchResponses, unknown, ThrowOnError, "fields">;
export declare const postPlacedOrderOrderTransitionsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostPlacedOrderOrderTransitionsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlacedOrderOrderTransitionsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve placed order billing address.
 */
export declare const getPlacedOrderByExternalReferenceCodePlacedOrderBillingAddress: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderByExternalReferenceCodePlacedOrderBillingAddressData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderByExternalReferenceCodePlacedOrderBillingAddressResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve placed order shipping address.
 */
export declare const getPlacedOrderByExternalReferenceCodePlacedOrderShippingAddress: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderByExternalReferenceCodePlacedOrderShippingAddressData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderByExternalReferenceCodePlacedOrderShippingAddressResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve placed order billing address.
 */
export declare const getPlacedOrderPlacedOrderBillingAddress: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderPlacedOrderBillingAddressData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderPlacedOrderBillingAddressResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve placed order shipping address.
 */
export declare const getPlacedOrderPlacedOrderShippingAddress: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderPlacedOrderShippingAddressData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderPlacedOrderShippingAddressResponses, unknown, ThrowOnError, "fields">;
export declare const getPlacedOrderByExternalReferenceCodePlacedOrderCommentsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderByExternalReferenceCodePlacedOrderCommentsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderByExternalReferenceCodePlacedOrderCommentsPageResponses, unknown, ThrowOnError, "fields">;
export declare const getPlacedOrderComment: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderCommentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderCommentResponses, unknown, ThrowOnError, "fields">;
export declare const getPlacedOrderCommentByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderCommentByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderCommentByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getPlacedOrderPlacedOrderCommentsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderPlacedOrderCommentsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderPlacedOrderCommentsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postPlacedOrderPlacedOrderCommentsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostPlacedOrderPlacedOrderCommentsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlacedOrderPlacedOrderCommentsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve placed order items.
 */
export declare const getPlacedOrderByExternalReferenceCodePlacedOrderItemsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderByExternalReferenceCodePlacedOrderItemsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderByExternalReferenceCodePlacedOrderItemsPageResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve information of the given Placed Order.
 */
export declare const getPlacedOrderItem: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderItemData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderItemResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve information of the given placed order item.
 */
export declare const getPlacedOrderItemByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderItemByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderItemByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve placed order items.
 */
export declare const getPlacedOrderPlacedOrderItemsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderPlacedOrderItemsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderPlacedOrderItemsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postPlacedOrderPlacedOrderItemsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostPlacedOrderPlacedOrderItemsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlacedOrderPlacedOrderItemsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve shipments of the given placed order item.
 */
export declare const getPlacedOrderItemByExternalReferenceCodePlacedOrderItemShipmentsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderItemByExternalReferenceCodePlacedOrderItemShipmentsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderItemByExternalReferenceCodePlacedOrderItemShipmentsPageResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve shipments of the given Placed Order Item.
 */
export declare const getPlacedOrderItemPlacedOrderItemShipmentsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderItemPlacedOrderItemShipmentsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderItemPlacedOrderItemShipmentsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postPlacedOrderItemPlacedOrderItemShipmentsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostPlacedOrderItemPlacedOrderItemShipmentsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlacedOrderItemPlacedOrderItemShipmentsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves placed orders for specific account in the given channel.
 */
export declare const getChannelAccountPlacedOrdersPage: <ThrowOnError extends boolean = false>(options: Options<GetChannelAccountPlacedOrdersPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetChannelAccountPlacedOrdersPageResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves placed orders for specific account in the given channel.
 */
export declare const getChannelByExternalReferenceCodeChannelExternalReferenceCodeAccountByExternalReferenceCodeAccountExternalReferenceCodePlacedOrdersPage: <ThrowOnError extends boolean = false>(options: Options<GetChannelByExternalReferenceCodeChannelExternalReferenceCodeAccountByExternalReferenceCodeAccountExternalReferenceCodePlacedOrdersPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetChannelByExternalReferenceCodeChannelExternalReferenceCodeAccountByExternalReferenceCodeAccountExternalReferenceCodePlacedOrdersPageResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves placed orders in the given channel.
 */
export declare const getChannelByExternalReferenceCodePlacedOrdersPage: <ThrowOnError extends boolean = false>(options: Options<GetChannelByExternalReferenceCodePlacedOrdersPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetChannelByExternalReferenceCodePlacedOrdersPageResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieves placed orders in the given channel.
 */
export declare const getChannelPlacedOrdersPage: <ThrowOnError extends boolean = false>(options: Options<GetChannelPlacedOrdersPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetChannelPlacedOrdersPageResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve information of the given Placed Order.
 */
export declare const getPlacedOrder: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderResponses, unknown, ThrowOnError, "fields">;
export declare const patchPlacedOrder: <ThrowOnError extends boolean = false>(options: Options<PatchPlacedOrderData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchPlacedOrderResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve information of the given Placed Order.
 */
export declare const getPlacedOrderByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const patchPlacedOrderByExternalReferenceCode: <ThrowOnError extends boolean = false>(options: Options<PatchPlacedOrderByExternalReferenceCodeData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PatchPlacedOrderByExternalReferenceCodeResponses, unknown, ThrowOnError, "fields">;
export declare const getPlacedOrderByExternalReferenceCodePaymentUrl: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderByExternalReferenceCodePaymentUrlData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderByExternalReferenceCodePaymentUrlResponses, unknown, ThrowOnError, "fields">;
export declare const getPlacedOrderPaymentUrl: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderPaymentUrlData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderPaymentUrlResponses, unknown, ThrowOnError, "fields">;
export declare const getPlacedOrderByExternalReferenceCodeShipmentsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderByExternalReferenceCodeShipmentsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderByExternalReferenceCodeShipmentsPageResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve placed order shipments.
 */
export declare const getPlacedOrderShipmentsPage: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderShipmentsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderShipmentsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postPlacedOrderShipmentsPageExportBatch: <ThrowOnError extends boolean = false>(options: Options<PostPlacedOrderShipmentsPageExportBatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostPlacedOrderShipmentsPageExportBatchResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve delivery term of the given Placed Order.
 */
export declare const getPlacedOrderByExternalReferenceCodeDeliveryTerm: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderByExternalReferenceCodeDeliveryTermData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderByExternalReferenceCodeDeliveryTermResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve payment term of the given Placed Order.
 */
export declare const getPlacedOrderByExternalReferenceCodePaymentTerm: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderByExternalReferenceCodePaymentTermData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderByExternalReferenceCodePaymentTermResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve delivery term of the given Placed Order.
 */
export declare const getPlacedOrderDeliveryTerm: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderDeliveryTermData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderDeliveryTermResponses, unknown, ThrowOnError, "fields">;
/**
 * Retrieve payment term of the given Placed Order.
 */
export declare const getPlacedOrderPaymentTerm: <ThrowOnError extends boolean = false>(options: Options<GetPlacedOrderPaymentTermData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlacedOrderPaymentTermResponses, unknown, ThrowOnError, "fields">;