@wix/ecom 1.0.520 → 1.0.522

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

@@ -1,606 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-export interface OrderWithFulfillments {
-    /** Order ID. */
-    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.
-     * @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;
-    /** Line items being fulfilled. */
-    lineItems?: FulfillmentLineItem[];
-    /**
-     * Fulfillment status.
-     *
-     * Supported values:
-     * + `"Pending"`
-     * + `"Accepted"`
-     * + `"Ready"`
-     * + `"In_Delivery"`
-     * + `"Fulfilled"`
-     */
-    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). */
-    _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`
-     */
-    quantity?: number | null;
-}
-export interface FulfillmentTrackingInfo {
-    /** Shipping/delivery tracking number. */
-    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'`
-     */
-    shippingProvider?: string | null;
-    /** Tracking link. Auto-filled if a predefined shipping provider is used, otherwise provided on creation. */
-    trackingLink?: string | null;
-}
-export interface CustomFulfillmentInfo {
-    /** Custom fulfillment info in key:value form. */
-    fieldsData?: Record<string, string>;
-}
-export interface FulfillmentCreated {
-    /** Order ID (auto generated upon order creation). */
-    orderId?: string;
-    /** ID of the newly created fulfillment. */
-    fulfillmentId?: string;
-    /** Fulfillment creation date and time. */
-    dateCreated?: Date;
-    /** Buyer information. */
-    buyerInfo?: BuyerInfo;
-    /** Order fulfillment status. */
-    fulfillmentStatus?: FulfillmentStatus;
-    /** Fulfillment tracking information. */
-    trackingInfo?: V2FulfillmentTrackingInfo;
-}
-/** Buyer Info */
-export interface BuyerInfo {
-    /** Wix customer ID */
-    _id?: string | null;
-    /**
-     * Deprecated (use identityType instead)
-     * @readonly
-     */
-    type?: IdentityType;
-    /** Customer type */
-    identityType?: IdentityType;
-    /**
-     * 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"
-}
-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"
-}
-export interface V2FulfillmentTrackingInfo {
-    /** Tracking number. */
-    trackingNumber?: string;
-    /**
-     * Shipping provider. Using the following shipping providers will allow for autofilling the tracking link:
-     * * `fedex`
-     * * `ups`
-     * * `usps`
-     * * `dhl`
-     * * `canadaPost`
-     */
-    shippingProvider?: string;
-    /** Tracking link - autofilled if using a predefined shipping provider, otherwise provided on creation. */
-    trackingLink?: string | null;
-}
-export interface FulfillmentUpdated {
-    /** Order ID (auto generated upon order creation). */
-    orderId?: string;
-    /** ID of the updated fulfillment. */
-    fulfillmentId?: string;
-    /** Fulfillment tracking information. */
-    trackingInfo?: V2FulfillmentTrackingInfo;
-}
-export interface FulfillmentDeleted {
-    /** Order ID (auto generated upon order creation). */
-    orderId?: string;
-    /** ID of the deleted fulfillment. */
-    fulfillmentId?: string;
-    /** Order fulfillment status. */
-    fulfillmentStatus?: FulfillmentStatus;
-}
-export interface ListFulfillmentsForSingleOrderRequest {
-    /** Order ID for which to retrieve fulfillments. */
-    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. */
-    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. */
-    orderId: string;
-    /** ID of the fulfillment to delete. */
-    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. */
-    ordersWithFulfillments: BulkCreateOrderWithFulfillments[];
-}
-export interface BulkCreateOrderWithFulfillments {
-    /** Order ID. */
-    orderId?: string;
-    /** Fulfillments associated with the order. */
-    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<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
-    _id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp. */
-    eventTime?: Date;
-    /**
-     * 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 defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
-     */
-    entityEventSequence?: string | null;
-}
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * 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?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-export interface ListFulfillmentsForSingleOrderResponseNonNullableFields {
-    orderWithFulfillments?: {
-        orderId: string;
-        fulfillments: {
-            lineItems: {
-                _id: string;
-            }[];
-        }[];
-    };
-}
-export interface ListFulfillmentsForMultipleOrdersResponseNonNullableFields {
-    ordersWithFulfillments: {
-        orderId: string;
-        fulfillments: {
-            lineItems: {
-                _id: string;
-            }[];
-        }[];
-    }[];
-}
-export interface CreateFulfillmentResponseNonNullableFields {
-    orderWithFulfillments?: {
-        orderId: string;
-        fulfillments: {
-            lineItems: {
-                _id: string;
-            }[];
-        }[];
-    };
-    fulfillmentId: string;
-}
-export interface UpdateFulfillmentResponseNonNullableFields {
-    orderWithFulfillments?: {
-        orderId: string;
-        fulfillments: {
-            lineItems: {
-                _id: string;
-            }[];
-        }[];
-    };
-}
-export interface DeleteFulfillmentResponseNonNullableFields {
-    orderWithFulfillments?: {
-        orderId: string;
-        fulfillments: {
-            lineItems: {
-                _id: string;
-            }[];
-        }[];
-    };
-}
-export interface BulkCreateFulfillmentResponseNonNullableFields {
-    results: {
-        itemMetadata?: {
-            originalIndex: number;
-            success: boolean;
-            error?: {
-                code: string;
-                description: string;
-            };
-        };
-        ordersWithFulfillments?: {
-            orderId: string;
-            fulfillments: {
-                lineItems: {
-                    _id: string;
-                }[];
-            }[];
-        };
-    }[];
-    bulkActionMetadata?: {
-        totalSuccesses: number;
-        totalFailures: number;
-        undetailedFailures: number;
-    };
-}
-export declare const onFulfillmentsUpdated: EventDefinition<DomainUpdatedEvent<OrderWithFulfillments>, "wix.ecom.v1.fulfillments_updated">;
-/**
- * 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
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.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 eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- */
-export declare function listFulfillmentsForSingleOrder(orderId: string): Promise<ListFulfillmentsForSingleOrderResponse & ListFulfillmentsForSingleOrderResponseNonNullableFields>;
-/**
- * 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
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.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 eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- */
-export declare function listFulfillmentsForMultipleOrders(orderIds: string[]): Promise<ListFulfillmentsForMultipleOrdersResponse & ListFulfillmentsForMultipleOrdersResponseNonNullableFields>;
-/**
- * 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
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- */
-export declare function createFulfillment(orderId: string, fulfillment: Fulfillment): Promise<CreateFulfillmentResponse & CreateFulfillmentResponseNonNullableFields>;
-/**
- * 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.
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @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.
- */
-export declare function updateFulfillment(identifiers: UpdateFulfillmentIdentifiers, options?: UpdateFulfillmentOptions): Promise<OrderWithFulfillments & NonNullable<UpdateFulfillmentResponseNonNullableFields>['orderWithFulfillments']>;
-export interface UpdateFulfillmentOptions {
-    /** Fulfillment info. */
-    fulfillment: {
-        /** Tracking info. */
-        trackingInfo?: FulfillmentTrackingInfo;
-        /** Custom fulfillment info. */
-        customInfo?: CustomFulfillmentInfo;
-        /**
-         * Fulfillment ID.
-         * @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;
-        /** Line items being fulfilled. */
-        lineItems?: FulfillmentLineItem[];
-        /**
-         * Fulfillment status.
-         *
-         * Supported values:
-         * + `"Pending"`
-         * + `"Accepted"`
-         * + `"Ready"`
-         * + `"In_Delivery"`
-         * + `"Fulfilled"`
-         */
-        status?: string | null;
-        /** Fulfillment handling complete. */
-        completed?: boolean | null;
-    };
-}
-export interface UpdateFulfillmentIdentifiers {
-    /**
-     * ID of the fulfillment to be updated.
-     * @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.
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- */
-export declare function deleteFulfillment(identifiers: DeleteFulfillmentIdentifiers): Promise<DeleteFulfillmentResponse & DeleteFulfillmentResponseNonNullableFields>;
-export interface DeleteFulfillmentIdentifiers {
-    /** ID of the fulfillment to delete. */
-    fulfillmentId: string;
-    /** Order ID. */
-    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
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- */
-export declare function bulkCreateFulfillments(ordersWithFulfillments: BulkCreateOrderWithFulfillments[]): Promise<BulkCreateFulfillmentResponse & BulkCreateFulfillmentResponseNonNullableFields>;