@wix/auto_sdk_ecom_order-fulfillments 1.0.7 → 1.0.9

package/build/{es/src/ecom-v1-fulfillments-order-fulfillments.types.d.ts → ecom-v1-fulfillments-order-fulfillments.universal-D89xmwPL.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,14 +160,14 @@ export interface BuyerInfo {
      */
     email?: string;
 }
-export declare enum IdentityType {
+declare enum IdentityType {
     UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
     /** Site member */
     MEMBER = "MEMBER",
     /** Contact */
     CONTACT = "CONTACT"
 }
-export declare enum FulfillmentStatus {
+declare enum FulfillmentStatus {
     /** None of the order items are fulfilled */
     NOT_FULFILLED = "NOT_FULFILLED",
     /**
@@ -180,7 +180,7 @@ export declare enum FulfillmentStatus {
     /** Some, but not all of the order items are fulfilled */
     PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
 }
-export interface V2FulfillmentTrackingInfo {
+interface V2FulfillmentTrackingInfo {
     /**
      * Tracking number.
      * @minLength 1
@@ -206,7 +206,7 @@ export interface V2FulfillmentTrackingInfo {
      */
     trackingLink?: string | null;
 }
-export interface FulfillmentUpdated {
+interface FulfillmentUpdated {
     /**
      * Order ID (auto generated upon order creation).
      * @format GUID
@@ -220,7 +220,7 @@ export interface FulfillmentUpdated {
     /** Fulfillment tracking information. */
     trackingInfo?: V2FulfillmentTrackingInfo;
 }
-export interface FulfillmentDeleted {
+interface FulfillmentDeleted {
     /**
      * Order ID (auto generated upon order creation).
      * @format GUID
@@ -234,7 +234,7 @@ export interface FulfillmentDeleted {
     /** Order fulfillment status. */
     fulfillmentStatus?: FulfillmentStatus;
 }
-export interface ListFulfillmentsForSingleOrderRequest {
+interface ListFulfillmentsForSingleOrderRequest {
     /**
      * Order ID for which to retrieve fulfillments.
      * @minLength 1
@@ -242,11 +242,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
@@ -254,33 +254,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
@@ -293,19 +293,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
@@ -318,20 +318,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. */
@@ -339,7 +340,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. */
@@ -347,7 +348,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. */
@@ -355,7 +356,7 @@ 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;
@@ -364,7 +365,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
      */
-    id?: string;
+    _id?: string;
     /**
      * Assumes actions are also always typed to an entity_type
      * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
@@ -398,36 +399,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
@@ -443,7 +442,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
@@ -468,7 +467,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -490,10 +489,131 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "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 {
+    /**
+     * 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 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 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;
+}
+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 EntityDeletedEvent as G, type ActionEvent as H, IdentityType as I, type IdentificationData as J, type IdentificationDataIdOneOf as K, type ListFulfillmentsForSingleOrderResponse as L, type MessageEnvelope as M, type BaseEventMetadata as N, type OrderWithFulfillments as O, type EventMetadata as P, type FulfillmentsUpdatedEnvelope 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, FulfillmentStatus as e, type FulfillmentFulfillmentInfoOneOf as f, type FulfillmentLineItem as g, type FulfillmentTrackingInfo as h, type CustomFulfillmentInfo as i, type FulfillmentCreated as j, type BuyerInfo as k, type FulfillmentUpdated as l, type FulfillmentDeleted as m, type ListFulfillmentsForSingleOrderRequest as n, type ListFulfillmentsForMultipleOrdersRequest as o, type CreateFulfillmentRequest as p, type UpdateFulfillmentRequest as q, type UpdateFulfillmentResponse as r, type DeleteFulfillmentRequest as s, type BulkCreateFulfillmentRequest as t, type BulkOrderFulfillmentsResult as u, type ItemMetadata as v, type BulkActionMetadata as w, type DomainEvent as x, type DomainEventBodyOneOf as y, type EntityUpdatedEvent as z };