@wix/auto_sdk_ecom_order-fulfillments 1.0.17 → 1.0.19

package/build/{es/src/ecom-v1-fulfillments-order-fulfillments.types.d.ts → ecom-v1-fulfillments-order-fulfillments.universal-DOM-x30R.d.mts}

@@ -1,4 +1,4 @@
-export interface OrderWithFulfillments {
+interface OrderWithFulfillments {
     /**
      * Order ID.
      * @minLength 1
@@ -9,7 +9,7 @@ export interface OrderWithFulfillments {
     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 {
+interface Fulfillment extends FulfillmentFulfillmentInfoOneOf {
     /** Tracking info. */
     trackingInfo?: FulfillmentTrackingInfo;
     /** Custom fulfillment info. */
@@ -19,12 +19,12 @@ export interface Fulfillment extends FulfillmentFulfillmentInfoOneOf {
      * @format GUID
      * @readonly
      */
-    id?: string | null;
+    _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;
+    _createdDate?: Date | null;
     /**
      * Line items being fulfilled.
      * @maxSize 300
@@ -47,18 +47,18 @@ export interface Fulfillment extends FulfillmentFulfillmentInfoOneOf {
     completed?: boolean | null;
 }
 /** @oneof */
-export interface FulfillmentFulfillmentInfoOneOf {
+interface FulfillmentFulfillmentInfoOneOf {
     /** Tracking info. */
     trackingInfo?: FulfillmentTrackingInfo;
     /** Custom fulfillment info. */
     customInfo?: CustomFulfillmentInfo;
 }
-export interface FulfillmentLineItem {
+interface FulfillmentLineItem {
     /**
      * Line item ID (mirrors the ID of the order line item).
      * @format GUID
      */
-    id?: string;
+    _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.
@@ -71,7 +71,7 @@ export interface FulfillmentLineItem {
      */
     quantity?: number | null;
 }
-export interface FulfillmentTrackingInfo {
+interface FulfillmentTrackingInfo {
     /**
      * Shipping/delivery tracking number.
      * @minLength 1
@@ -97,14 +97,14 @@ export interface FulfillmentTrackingInfo {
      */
     trackingLink?: string | null;
 }
-export interface CustomFulfillmentInfo {
+interface CustomFulfillmentInfo {
     /**
      * Custom fulfillment info in key:value form.
      * @maxSize 100
      */
     fieldsData?: Record<string, string>;
 }
-export interface FulfillmentCreated {
+interface FulfillmentCreated {
     /**
      * Order ID (auto generated upon order creation).
      * @format GUID
@@ -125,12 +125,12 @@ export interface FulfillmentCreated {
     trackingInfo?: V2FulfillmentTrackingInfo;
 }
 /** Buyer Info */
-export interface BuyerInfo {
+interface BuyerInfo {
     /**
      * Wix customer ID
      * @format GUID
      */
-    id?: string | null;
+    _id?: string | null;
     /**
      * Deprecated (use identityType instead)
      * @readonly
@@ -160,7 +160,7 @@ export interface BuyerInfo {
      */
     email?: string;
 }
-export declare enum IdentityType {
+declare enum IdentityType {
     UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
     /** Site member */
     MEMBER = "MEMBER",
@@ -168,8 +168,8 @@ export declare enum IdentityType {
     CONTACT = "CONTACT"
 }
 /** @enumType */
-export type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
-export declare enum FulfillmentStatus {
+type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
+declare enum FulfillmentStatus {
     /** None of the order items are fulfilled */
     NOT_FULFILLED = "NOT_FULFILLED",
     /**
@@ -183,8 +183,8 @@ export declare enum FulfillmentStatus {
     PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
 }
 /** @enumType */
-export type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'CANCELED' | 'PARTIALLY_FULFILLED';
-export interface V2FulfillmentTrackingInfo {
+type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'CANCELED' | 'PARTIALLY_FULFILLED';
+interface V2FulfillmentTrackingInfo {
     /**
      * Tracking number.
      * @minLength 1
@@ -210,7 +210,7 @@ export interface V2FulfillmentTrackingInfo {
      */
     trackingLink?: string | null;
 }
-export interface FulfillmentUpdated {
+interface FulfillmentUpdated {
     /**
      * Order ID (auto generated upon order creation).
      * @format GUID
@@ -224,7 +224,7 @@ export interface FulfillmentUpdated {
     /** Fulfillment tracking information. */
     trackingInfo?: V2FulfillmentTrackingInfo;
 }
-export interface FulfillmentDeleted {
+interface FulfillmentDeleted {
     /**
      * Order ID (auto generated upon order creation).
      * @format GUID
@@ -238,7 +238,7 @@ export interface FulfillmentDeleted {
     /** Order fulfillment status. */
     fulfillmentStatus?: FulfillmentStatusWithLiterals;
 }
-export interface ListFulfillmentsForSingleOrderRequest {
+interface ListFulfillmentsForSingleOrderRequest {
     /**
      * Order ID for which to retrieve fulfillments.
      * @minLength 1
@@ -246,11 +246,11 @@ export interface ListFulfillmentsForSingleOrderRequest {
      */
     orderId: string;
 }
-export interface ListFulfillmentsForSingleOrderResponse {
+interface ListFulfillmentsForSingleOrderResponse {
     /** List of fulfillments associated with the order. */
     orderWithFulfillments?: OrderWithFulfillments;
 }
-export interface ListFulfillmentsForMultipleOrdersRequest {
+interface ListFulfillmentsForMultipleOrdersRequest {
     /**
      * List of order IDs for which to retrieve fulfillments.
      * @minSize 1
@@ -258,33 +258,33 @@ export interface ListFulfillmentsForMultipleOrdersRequest {
      */
     orderIds: string[];
 }
-export interface ListFulfillmentsForMultipleOrdersResponse {
+interface ListFulfillmentsForMultipleOrdersResponse {
     /** List of order IDs and their associated fulfillments. */
     ordersWithFulfillments?: OrderWithFulfillments[];
 }
-export interface CreateFulfillmentRequest {
+interface CreateFulfillmentRequest {
     /** Order ID. */
     orderId: string;
     /** Fulfillment info. */
     fulfillment: Fulfillment;
 }
-export interface CreateFulfillmentResponse {
+interface CreateFulfillmentResponse {
     /** Order ID and the orders' fulfillments. */
     orderWithFulfillments?: OrderWithFulfillments;
     /** ID of created fulfillment. */
     fulfillmentId?: string;
 }
-export interface UpdateFulfillmentRequest {
+interface UpdateFulfillmentRequest {
     /** Order ID. */
     orderId: string;
     /** Fulfillment info to update. */
     fulfillment?: Fulfillment;
 }
-export interface UpdateFulfillmentResponse {
+interface UpdateFulfillmentResponse {
     /** Order ID and the orders' associated fulfillments after update. */
     orderWithFulfillments?: OrderWithFulfillments;
 }
-export interface DeleteFulfillmentRequest {
+interface DeleteFulfillmentRequest {
     /**
      * Order ID.
      * @minLength 1
@@ -297,19 +297,19 @@ export interface DeleteFulfillmentRequest {
      */
     fulfillmentId: string;
 }
-export interface DeleteFulfillmentResponse {
+interface DeleteFulfillmentResponse {
     /** Order ID and the order's associated fulfillments after deletion. */
     orderWithFulfillments?: OrderWithFulfillments;
 }
-export interface BulkCreateFulfillmentRequest {
+interface BulkCreateFulfillmentRequest {
     /**
-     * List of order IDs and their associated fulfillments.
+     * List of order IDs and their associated fulfillments' info.
      * @minSize 1
      * @maxSize 100
      */
     ordersWithFulfillments: BulkCreateOrderWithFulfillments[];
 }
-export interface BulkCreateOrderWithFulfillments {
+interface BulkCreateOrderWithFulfillments {
     /**
      * Order ID.
      * @minLength 1
@@ -322,20 +322,21 @@ export interface BulkCreateOrderWithFulfillments {
      */
     fulfillments?: Fulfillment[];
 }
-export interface BulkCreateFulfillmentResponse {
+interface BulkCreateFulfillmentResponse {
     /** Items updated by bulk action. */
     results?: BulkOrderFulfillmentsResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface BulkOrderFulfillmentsResult {
+interface BulkOrderFulfillmentsResult {
     /** Item metadata. */
     itemMetadata?: ItemMetadata;
+    /** List of order IDs and their associated fulfillments. */
     ordersWithFulfillments?: OrderWithFulfillments;
 }
-export interface ItemMetadata {
+interface ItemMetadata {
     /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    id?: string | null;
+    _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. */
@@ -343,7 +344,7 @@ export interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-export interface ApplicationError {
+interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -351,7 +352,7 @@ export interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-export interface BulkActionMetadata {
+interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -359,13 +360,13 @@ export interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+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;
+    _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`.
@@ -394,36 +395,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
+interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
      */
-    currentEntityAsJson?: string;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent {
-    bodyAsJson?: string;
+interface ActionEvent {
+    body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -439,7 +438,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -464,7 +463,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -486,7 +485,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -494,4 +493,117 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+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;
+}
+interface FulfillmentsUpdatedEnvelope {
+    entity: OrderWithFulfillments;
+    metadata: EventMetadata;
+}
+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;
+    };
+}
+interface UpdateFulfillmentIdentifiers {
+    /**
+     * ID of the fulfillment to be updated.
+     * @format GUID
+     * @readonly
+     */
+    fulfillmentId?: string | null;
+    /** Order ID. */
+    orderId: string;
+}
+interface DeleteFulfillmentIdentifiers {
+    /**
+     * ID of the fulfillment to delete.
+     * @format GUID
+     */
+    fulfillmentId: string;
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId: string;
+}
+
+export { type ApplicationError as A, type BulkCreateOrderWithFulfillments as B, type CreateFulfillmentResponse as C, type DeleteFulfillmentIdentifiers as D, type EntityCreatedEvent as E, type Fulfillment as F, type EntityUpdatedEvent as G, type EntityDeletedEvent as H, IdentityType as I, type ActionEvent as J, type IdentificationData as K, type ListFulfillmentsForSingleOrderResponse as L, type MessageEnvelope as M, type IdentificationDataIdOneOf as N, type OrderWithFulfillments as O, type BaseEventMetadata as P, type EventMetadata as Q, type RestoreInfo as R, type UpdateFulfillmentIdentifiers as U, type V2FulfillmentTrackingInfo as V, WebhookIdentityType as W, type ListFulfillmentsForMultipleOrdersResponse as a, type UpdateFulfillmentOptions as b, type DeleteFulfillmentResponse as c, type BulkCreateFulfillmentResponse as d, type FulfillmentsUpdatedEnvelope as e, FulfillmentStatus as f, type FulfillmentFulfillmentInfoOneOf as g, type FulfillmentLineItem as h, type FulfillmentTrackingInfo as i, type CustomFulfillmentInfo as j, type FulfillmentCreated as k, type BuyerInfo as l, type FulfillmentUpdated as m, type FulfillmentDeleted as n, type ListFulfillmentsForSingleOrderRequest as o, type ListFulfillmentsForMultipleOrdersRequest as p, type CreateFulfillmentRequest as q, type UpdateFulfillmentRequest as r, type UpdateFulfillmentResponse as s, type DeleteFulfillmentRequest as t, type BulkCreateFulfillmentRequest as u, type BulkOrderFulfillmentsResult as v, type ItemMetadata as w, type BulkActionMetadata as x, type DomainEvent as y, type DomainEventBodyOneOf as z };