@wix/auto_sdk_ecom_order-fulfillments 1.0.17 → 1.0.18

package/build/es/src/ecom-v1-fulfillments-order-fulfillments.universal.d.ts

@@ -1,817 +0,0 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-export interface OrderWithFulfillments {
-    /**
-     * Order ID.
-     * @minLength 1
-     * @maxLength 100
-     */
-    orderId?: string;
-    /** Fulfillments associated with the order. */
-    fulfillments?: Fulfillment[];
-}
-/** for now, this is a sub-object of Orders, so can refer to order line items by id. */
-export interface Fulfillment extends FulfillmentFulfillmentInfoOneOf {
-    /** Tracking info. */
-    trackingInfo?: FulfillmentTrackingInfo;
-    /** Custom fulfillment info. */
-    customInfo?: CustomFulfillmentInfo;
-    /**
-     * Fulfillment ID.
-     * @format GUID
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Fulfillment creation date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /**
-     * Line items being fulfilled.
-     * @maxSize 300
-     */
-    lineItems?: FulfillmentLineItem[];
-    /**
-     * __Optional.__ Fulfillment status.
-     *
-     * Supported values:
-     * + `"Pending"`
-     * + `"Accepted"`
-     * + `"Ready"`
-     * + `"In_Delivery"`
-     * + `"Fulfilled"`
-     * @minLength 1
-     * @maxLength 100
-     */
-    status?: string | null;
-    /** Fulfillment handling complete. */
-    completed?: boolean | null;
-}
-/** @oneof */
-export interface FulfillmentFulfillmentInfoOneOf {
-    /** Tracking info. */
-    trackingInfo?: FulfillmentTrackingInfo;
-    /** Custom fulfillment info. */
-    customInfo?: CustomFulfillmentInfo;
-}
-export interface FulfillmentLineItem {
-    /**
-     * Line item ID (mirrors the ID of the order line item).
-     * @format GUID
-     */
-    _id?: string;
-    /**
-     * Line item quantity.
-     * * If this property isn't passed on creation, it defaults to the number of items not already linked to a fulfillment.
-     * * If the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error is returned.
-     *
-     * Min: `1`
-     * Max: `100000`
-     * @min 1
-     * @max 100000
-     */
-    quantity?: number | null;
-}
-export interface FulfillmentTrackingInfo {
-    /**
-     * Shipping/delivery tracking number.
-     * @minLength 1
-     * @maxLength 100
-     */
-    trackingNumber?: string | null;
-    /**
-     * Shipping provider. Using one of the following shipping providers will allow for auto-filling the tracking link:
-     * * `'fedex'`
-     * * `'ups'`
-     * * `'usps'`
-     * * `'dhl'`
-     * * `'canadaPost'`
-     * @minLength 1
-     * @maxLength 100
-     */
-    shippingProvider?: string | null;
-    /**
-     * Tracking link. Auto-filled if a predefined shipping provider is used, otherwise provided on creation.
-     * @minLength 1
-     * @maxLength 2048
-     * @format WEB_URL
-     */
-    trackingLink?: string | null;
-}
-export interface CustomFulfillmentInfo {
-    /**
-     * Custom fulfillment info in key:value form.
-     * @maxSize 100
-     */
-    fieldsData?: Record<string, string>;
-}
-export interface FulfillmentCreated {
-    /**
-     * Order ID (auto generated upon order creation).
-     * @format GUID
-     */
-    orderId?: string;
-    /**
-     * ID of the newly created fulfillment.
-     * @format GUID
-     */
-    fulfillmentId?: string;
-    /** Fulfillment creation date and time. */
-    dateCreated?: Date | null;
-    /** Buyer information. */
-    buyerInfo?: BuyerInfo;
-    /** Order fulfillment status. */
-    fulfillmentStatus?: FulfillmentStatusWithLiterals;
-    /** Fulfillment tracking information. */
-    trackingInfo?: V2FulfillmentTrackingInfo;
-}
-/** Buyer Info */
-export interface BuyerInfo {
-    /**
-     * Wix customer ID
-     * @format GUID
-     */
-    _id?: string | null;
-    /**
-     * Deprecated (use identityType instead)
-     * @readonly
-     * @deprecated
-     */
-    type?: IdentityTypeWithLiterals;
-    /** Customer type */
-    identityType?: IdentityTypeWithLiterals;
-    /**
-     * Customer's first name
-     * @readonly
-     */
-    firstName?: string;
-    /**
-     * Customer's last name
-     * @readonly
-     */
-    lastName?: string;
-    /**
-     * Customer's phone number
-     * @readonly
-     */
-    phone?: string | null;
-    /**
-     * Customer's email address
-     * @readonly
-     */
-    email?: string;
-}
-export declare enum IdentityType {
-    UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
-    /** Site member */
-    MEMBER = "MEMBER",
-    /** Contact */
-    CONTACT = "CONTACT"
-}
-/** @enumType */
-export type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
-export declare enum FulfillmentStatus {
-    /** None of the order items are fulfilled */
-    NOT_FULFILLED = "NOT_FULFILLED",
-    /**
-     * All of the order items are fulfilled
-     * Orders without shipping info are fulfilled automatically
-     */
-    FULFILLED = "FULFILLED",
-    /** Order is canceled */
-    CANCELED = "CANCELED",
-    /** Some, but not all of the order items are fulfilled */
-    PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
-}
-/** @enumType */
-export type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'CANCELED' | 'PARTIALLY_FULFILLED';
-export interface V2FulfillmentTrackingInfo {
-    /**
-     * Tracking number.
-     * @minLength 1
-     * @maxLength 100
-     */
-    trackingNumber?: string;
-    /**
-     * Shipping provider. Using the following shipping providers will allow for autofilling the tracking link:
-     * * `fedex`
-     * * `ups`
-     * * `usps`
-     * * `dhl`
-     * * `canadaPost`
-     * @minLength 1
-     * @maxLength 100
-     */
-    shippingProvider?: string;
-    /**
-     * Tracking link - autofilled if using a predefined shipping provider, otherwise provided on creation.
-     * @minLength 1
-     * @maxLength 2048
-     * @format WEB_URL
-     */
-    trackingLink?: string | null;
-}
-export interface FulfillmentUpdated {
-    /**
-     * Order ID (auto generated upon order creation).
-     * @format GUID
-     */
-    orderId?: string;
-    /**
-     * ID of the updated fulfillment.
-     * @format GUID
-     */
-    fulfillmentId?: string;
-    /** Fulfillment tracking information. */
-    trackingInfo?: V2FulfillmentTrackingInfo;
-}
-export interface FulfillmentDeleted {
-    /**
-     * Order ID (auto generated upon order creation).
-     * @format GUID
-     */
-    orderId?: string;
-    /**
-     * ID of the deleted fulfillment.
-     * @format GUID
-     */
-    fulfillmentId?: string;
-    /** Order fulfillment status. */
-    fulfillmentStatus?: FulfillmentStatusWithLiterals;
-}
-export interface ListFulfillmentsForSingleOrderRequest {
-    /**
-     * Order ID for which to retrieve fulfillments.
-     * @minLength 1
-     * @maxLength 100
-     */
-    orderId: string;
-}
-export interface ListFulfillmentsForSingleOrderResponse {
-    /** List of fulfillments associated with the order. */
-    orderWithFulfillments?: OrderWithFulfillments;
-}
-export interface ListFulfillmentsForMultipleOrdersRequest {
-    /**
-     * List of order IDs for which to retrieve fulfillments.
-     * @minSize 1
-     * @maxSize 100
-     */
-    orderIds: string[];
-}
-export interface ListFulfillmentsForMultipleOrdersResponse {
-    /** List of order IDs and their associated fulfillments. */
-    ordersWithFulfillments?: OrderWithFulfillments[];
-}
-export interface CreateFulfillmentRequest {
-    /** Order ID. */
-    orderId: string;
-    /** Fulfillment info. */
-    fulfillment: Fulfillment;
-}
-export interface CreateFulfillmentResponse {
-    /** Order ID and the orders' fulfillments. */
-    orderWithFulfillments?: OrderWithFulfillments;
-    /** ID of created fulfillment. */
-    fulfillmentId?: string;
-}
-export interface UpdateFulfillmentRequest {
-    /** Order ID. */
-    orderId: string;
-    /** Fulfillment info to update. */
-    fulfillment?: Fulfillment;
-}
-export interface UpdateFulfillmentResponse {
-    /** Order ID and the orders' associated fulfillments after update. */
-    orderWithFulfillments?: OrderWithFulfillments;
-}
-export interface DeleteFulfillmentRequest {
-    /**
-     * Order ID.
-     * @minLength 1
-     * @maxLength 100
-     */
-    orderId: string;
-    /**
-     * ID of the fulfillment to delete.
-     * @format GUID
-     */
-    fulfillmentId: string;
-}
-export interface DeleteFulfillmentResponse {
-    /** Order ID and the order's associated fulfillments after deletion. */
-    orderWithFulfillments?: OrderWithFulfillments;
-}
-export interface BulkCreateFulfillmentRequest {
-    /**
-     * List of order IDs and their associated fulfillments' info.
-     * @minSize 1
-     * @maxSize 100
-     */
-    ordersWithFulfillments: BulkCreateOrderWithFulfillments[];
-}
-export interface BulkCreateOrderWithFulfillments {
-    /**
-     * Order ID.
-     * @minLength 1
-     * @maxLength 100
-     */
-    orderId?: string;
-    /**
-     * Fulfillments associated with the order.
-     * @minSize 1
-     */
-    fulfillments?: Fulfillment[];
-}
-export interface BulkCreateFulfillmentResponse {
-    /** Items updated by bulk action. */
-    results?: BulkOrderFulfillmentsResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkOrderFulfillmentsResult {
-    /** Item metadata. */
-    itemMetadata?: ItemMetadata;
-    /** List of order IDs and their associated fulfillments. */
-    ordersWithFulfillments?: OrderWithFulfillments;
-}
-export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    _id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError;
-}
-export interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-export interface BulkActionMetadata {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
-}
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    _id?: string;
-    /**
-     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
-     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
-     */
-    entityFqdn?: string;
-    /**
-     * Event action name, placed at the top level to make it easier for users to dispatch messages.
-     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
-    eventTime?: Date | null;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
-     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
-     */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entity?: string;
-}
-export interface RestoreInfo {
-    deletedDate?: Date | null;
-}
-export interface EntityUpdatedEvent {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntity?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted. */
-    deletedEntity?: string | null;
-}
-export interface ActionEvent {
-    body?: string;
-}
-export interface MessageEnvelope {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-export interface IdentificationData extends IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-/** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-export interface BaseEventMetadata {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-}
-export interface EventMetadata extends BaseEventMetadata {
-    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    _id?: string;
-    /**
-     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
-     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
-     */
-    entityFqdn?: string;
-    /**
-     * Event action name, placed at the top level to make it easier for users to dispatch messages.
-     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
-    eventTime?: Date | null;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
-     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
-     */
-    entityEventSequence?: string | null;
-}
-export interface FulfillmentsUpdatedEnvelope {
-    entity: OrderWithFulfillments;
-    metadata: EventMetadata;
-}
-/**
- * Triggered when one or more of an order's fulfillments are created, updated, or deleted.
- *
- * The response contains the order's ID and details about all of its fulfillments following the change.
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
- * @permissionScope Read Stores - all read permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @permissionId ECOM.READ_FULFILLMENTS
- * @webhook
- * @eventType wix.ecom.v1.fulfillments_updated
- * @serviceIdentifier com.wix.ecom.orders.fulfillments.v1.Fulfillments
- * @slug updated
- */
-export declare function onFulfillmentsUpdated(handler: (event: FulfillmentsUpdatedEnvelope) => void | Promise<void>): void;
-type FulfillmentsNonNullablePaths = `orderId` | `fulfillments`;
-/**
- * Retrieves fulfillments associated with a specified order.
- *
- *
- * The `listFulfillmentsForSingleOrder()` function returns a Promise that resolves when the fulfillments are retrieved.
- * @param orderId - Order ID for which to retrieve fulfillments.
- * @public
- * @requiredField orderId
- * @permissionId ECOM.READ_FULFILLMENTS
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
- * @permissionScope Read Stores - all read permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @fqn com.wix.ecom.orders.fulfillments.v1.Fulfillments.ListFulfillmentsForSingleOrder
- */
-export declare function listFulfillmentsForSingleOrder(orderId: string): Promise<NonNullablePaths<ListFulfillmentsForSingleOrderResponse, {
-    [P in FulfillmentsNonNullablePaths]: `orderWithFulfillments.${P}`;
-}[FulfillmentsNonNullablePaths]>>;
-/**
- * Retrieves fulfillments associated with multiple specified orders.
- *
- *
- * The `listFulfillmentsForMultipleOrders()` function returns a Promise that resolves when the fulfillments are retrieved.
- * @param orderIds - List of order IDs for which to retrieve fulfillments.
- * @public
- * @requiredField orderIds
- * @permissionId ECOM.READ_FULFILLMENTS
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
- * @permissionScope Read Stores - all read permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @fqn com.wix.ecom.orders.fulfillments.v1.Fulfillments.ListFulfillmentsForMultipleOrders
- */
-export declare function listFulfillmentsForMultipleOrders(orderIds: string[]): Promise<NonNullablePaths<ListFulfillmentsForMultipleOrdersResponse, {
-    [P in FulfillmentsNonNullablePaths]: `ordersWithFulfillments.${number}.${P}`;
-}[FulfillmentsNonNullablePaths]>>;
-/**
- * Creates an order fulfillment.
- *
- *
- * The `createFulfillment()` function returns a Promise that resolves when the fulfillment is created.
- * @param orderId - Order ID.
- * @param fulfillment - Fulfillment info.
- * @public
- * @requiredField fulfillment
- * @requiredField fulfillment.lineItems
- * @requiredField fulfillment.lineItems._id
- * @requiredField orderId
- * @permissionId ECOM.MODIFY_FULFILLMENTS
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- * @fqn com.wix.ecom.orders.fulfillments.v1.Fulfillments.CreateFulfillment
- */
-export declare function createFulfillment(orderId: string, fulfillment: NonNullablePaths<Fulfillment, `lineItems` | `lineItems.${number}._id`>): Promise<NonNullablePaths<CreateFulfillmentResponse, {
-    [P in FulfillmentsNonNullablePaths]: `orderWithFulfillments.${P}`;
-}[FulfillmentsNonNullablePaths] | `fulfillmentId`>>;
-/**
- * Updates a fulfillment's properties.
- * To update a field's value, include the new value in the `fulfillment` field in the body params.
- * To remove a field's value, pass `null`.
- *
- *
- * The `updateFulfillment()` function returns a Promise that resolves when the fulfillment is updated.
- *
- * > **Note:** Updating line item IDs or fulfilled quantities is not allowed. To update line item IDs or quantities, delete the fulfillment and create it again.
- * @public
- * @requiredField identifiers
- * @requiredField identifiers.fulfillmentId
- * @requiredField identifiers.orderId
- * @param identifiers - Order and fulfillment IDs to be updated.
- * @param options - Available options to use when updating a fulfillment.
- * @permissionId ECOM.MODIFY_FULFILLMENTS
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- * @returns Order ID and the orders' associated fulfillments after update.
- * @fqn com.wix.ecom.orders.fulfillments.v1.Fulfillments.UpdateFulfillment
- */
-export declare function updateFulfillment(identifiers: NonNullablePaths<UpdateFulfillmentIdentifiers, `fulfillmentId` | `orderId`>, options?: UpdateFulfillmentOptions): Promise<NonNullablePaths<OrderWithFulfillments, FulfillmentsNonNullablePaths>>;
-export interface UpdateFulfillmentOptions {
-    /** Fulfillment info. */
-    fulfillment: {
-        /** Tracking info. */
-        trackingInfo?: FulfillmentTrackingInfo;
-        /** Custom fulfillment info. */
-        customInfo?: CustomFulfillmentInfo;
-        /**
-         * Fulfillment ID.
-         * @format GUID
-         * @readonly
-         */
-        _id?: string | null;
-        /**
-         * Fulfillment creation date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-         * @readonly
-         */
-        _createdDate?: Date | null;
-        /**
-         * Line items being fulfilled.
-         * @maxSize 300
-         */
-        lineItems?: FulfillmentLineItem[];
-        /**
-         * __Optional.__ Fulfillment status.
-         *
-         * Supported values:
-         * + `"Pending"`
-         * + `"Accepted"`
-         * + `"Ready"`
-         * + `"In_Delivery"`
-         * + `"Fulfilled"`
-         * @minLength 1
-         * @maxLength 100
-         */
-        status?: string | null;
-        /** Fulfillment handling complete. */
-        completed?: boolean | null;
-    };
-}
-export interface UpdateFulfillmentIdentifiers {
-    /**
-     * ID of the fulfillment to be updated.
-     * @format GUID
-     * @readonly
-     */
-    fulfillmentId?: string | null;
-    /** Order ID. */
-    orderId: string;
-}
-/**
- * Deletes an existing order fulfillment.
- *
- *
- * The `deleteFulfillment()` function returns a Promise that resolves when the fulfillment is deleted.
- * @public
- * @requiredField identifiers
- * @requiredField identifiers.fulfillmentId
- * @requiredField identifiers.orderId
- * @param identifiers - Order and fulfillment IDs.
- * @permissionId ECOM.MODIFY_FULFILLMENTS
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- * @fqn com.wix.ecom.orders.fulfillments.v1.Fulfillments.DeleteFulfillment
- */
-export declare function deleteFulfillment(identifiers: NonNullablePaths<DeleteFulfillmentIdentifiers, `fulfillmentId` | `orderId`>): Promise<NonNullablePaths<DeleteFulfillmentResponse, {
-    [P in FulfillmentsNonNullablePaths]: `orderWithFulfillments.${P}`;
-}[FulfillmentsNonNullablePaths]>>;
-export interface DeleteFulfillmentIdentifiers {
-    /**
-     * ID of the fulfillment to delete.
-     * @format GUID
-     */
-    fulfillmentId: string;
-    /**
-     * Order ID.
-     * @minLength 1
-     * @maxLength 100
-     */
-    orderId: string;
-}
-/**
- * Creates multiple fulfillments for one or more orders.
- *
- *
- * The `bulkCreateFulfillments()` function returns a Promise that resolves when the fulfillments are created.
- * @param ordersWithFulfillments - List of order IDs and their associated fulfillments' info.
- * @public
- * @requiredField ordersWithFulfillments
- * @requiredField ordersWithFulfillments.fulfillments
- * @requiredField ordersWithFulfillments.fulfillments.lineItems
- * @requiredField ordersWithFulfillments.fulfillments.lineItems._id
- * @requiredField ordersWithFulfillments.orderId
- * @permissionId ECOM.MODIFY_FULFILLMENTS
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- * @fqn com.wix.ecom.orders.fulfillments.v1.Fulfillments.BulkCreateFulfillment
- */
-export declare function bulkCreateFulfillments(ordersWithFulfillments: NonNullablePaths<BulkCreateOrderWithFulfillments, `fulfillments` | `fulfillments.${number}.lineItems` | `fulfillments.${number}.lineItems.${number}._id` | `orderId`>[]): Promise<NonNullablePaths<BulkCreateFulfillmentResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
-    [P in FulfillmentsNonNullablePaths]: `results.${number}.ordersWithFulfillments.${P}`;
-}[FulfillmentsNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
-export {};