@wix/auto_sdk_ecom_order-fulfillments 1.0.9 → 1.0.10

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

@@ -1,4 +1,4 @@
-interface OrderWithFulfillments {
+export interface OrderWithFulfillments {
     /**
      * Order ID.
      * @minLength 1
@@ -9,7 +9,7 @@ interface OrderWithFulfillments {
     fulfillments?: Fulfillment[];
 }
 /** for now, this is a sub-object of Orders, so can refer to order line items by id. */
-interface Fulfillment extends FulfillmentFulfillmentInfoOneOf {
+export interface Fulfillment extends FulfillmentFulfillmentInfoOneOf {
     /** Tracking info. */
     trackingInfo?: FulfillmentTrackingInfo;
     /** Custom fulfillment info. */
@@ -19,12 +19,12 @@ 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 @@ interface Fulfillment extends FulfillmentFulfillmentInfoOneOf {
     completed?: boolean | null;
 }
 /** @oneof */
-interface FulfillmentFulfillmentInfoOneOf {
+export interface FulfillmentFulfillmentInfoOneOf {
     /** Tracking info. */
     trackingInfo?: FulfillmentTrackingInfo;
     /** Custom fulfillment info. */
     customInfo?: CustomFulfillmentInfo;
 }
-interface FulfillmentLineItem {
+export 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 @@ interface FulfillmentLineItem {
      */
     quantity?: number | null;
 }
-interface FulfillmentTrackingInfo {
+export interface FulfillmentTrackingInfo {
     /**
      * Shipping/delivery tracking number.
      * @minLength 1
@@ -97,14 +97,14 @@ interface FulfillmentTrackingInfo {
      */
     trackingLink?: string | null;
 }
-interface CustomFulfillmentInfo {
+export interface CustomFulfillmentInfo {
     /**
      * Custom fulfillment info in key:value form.
      * @maxSize 100
      */
     fieldsData?: Record<string, string>;
 }
-interface FulfillmentCreated {
+export interface FulfillmentCreated {
     /**
      * Order ID (auto generated upon order creation).
      * @format GUID
@@ -125,12 +125,12 @@ interface FulfillmentCreated {
     trackingInfo?: V2FulfillmentTrackingInfo;
 }
 /** Buyer Info */
-interface BuyerInfo {
+export interface BuyerInfo {
     /**
      * Wix customer ID
      * @format GUID
      */
-    _id?: string | null;
+    id?: string | null;
     /**
      * Deprecated (use identityType instead)
      * @readonly
@@ -160,14 +160,14 @@ interface BuyerInfo {
      */
     email?: string;
 }
-declare enum IdentityType {
+export declare enum IdentityType {
     UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
     /** Site member */
     MEMBER = "MEMBER",
     /** Contact */
     CONTACT = "CONTACT"
 }
-declare enum FulfillmentStatus {
+export declare enum FulfillmentStatus {
     /** None of the order items are fulfilled */
     NOT_FULFILLED = "NOT_FULFILLED",
     /**
@@ -180,7 +180,7 @@ declare enum FulfillmentStatus {
     /** Some, but not all of the order items are fulfilled */
     PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
 }
-interface V2FulfillmentTrackingInfo {
+export interface V2FulfillmentTrackingInfo {
     /**
      * Tracking number.
      * @minLength 1
@@ -206,7 +206,7 @@ interface V2FulfillmentTrackingInfo {
      */
     trackingLink?: string | null;
 }
-interface FulfillmentUpdated {
+export interface FulfillmentUpdated {
     /**
      * Order ID (auto generated upon order creation).
      * @format GUID
@@ -220,7 +220,7 @@ interface FulfillmentUpdated {
     /** Fulfillment tracking information. */
     trackingInfo?: V2FulfillmentTrackingInfo;
 }
-interface FulfillmentDeleted {
+export interface FulfillmentDeleted {
     /**
      * Order ID (auto generated upon order creation).
      * @format GUID
@@ -234,7 +234,7 @@ interface FulfillmentDeleted {
     /** Order fulfillment status. */
     fulfillmentStatus?: FulfillmentStatus;
 }
-interface ListFulfillmentsForSingleOrderRequest {
+export interface ListFulfillmentsForSingleOrderRequest {
     /**
      * Order ID for which to retrieve fulfillments.
      * @minLength 1
@@ -242,11 +242,11 @@ interface ListFulfillmentsForSingleOrderRequest {
      */
     orderId: string;
 }
-interface ListFulfillmentsForSingleOrderResponse {
+export interface ListFulfillmentsForSingleOrderResponse {
     /** List of fulfillments associated with the order. */
     orderWithFulfillments?: OrderWithFulfillments;
 }
-interface ListFulfillmentsForMultipleOrdersRequest {
+export interface ListFulfillmentsForMultipleOrdersRequest {
     /**
      * List of order IDs for which to retrieve fulfillments.
      * @minSize 1
@@ -254,33 +254,33 @@ interface ListFulfillmentsForMultipleOrdersRequest {
      */
     orderIds: string[];
 }
-interface ListFulfillmentsForMultipleOrdersResponse {
+export interface ListFulfillmentsForMultipleOrdersResponse {
     /** List of order IDs and their associated fulfillments. */
     ordersWithFulfillments?: OrderWithFulfillments[];
 }
-interface CreateFulfillmentRequest {
+export interface CreateFulfillmentRequest {
     /** Order ID. */
     orderId: string;
     /** Fulfillment info. */
     fulfillment: Fulfillment;
 }
-interface CreateFulfillmentResponse {
+export interface CreateFulfillmentResponse {
     /** Order ID and the orders' fulfillments. */
     orderWithFulfillments?: OrderWithFulfillments;
     /** ID of created fulfillment. */
     fulfillmentId?: string;
 }
-interface UpdateFulfillmentRequest {
+export interface UpdateFulfillmentRequest {
     /** Order ID. */
     orderId: string;
     /** Fulfillment info to update. */
     fulfillment?: Fulfillment;
 }
-interface UpdateFulfillmentResponse {
+export interface UpdateFulfillmentResponse {
     /** Order ID and the orders' associated fulfillments after update. */
     orderWithFulfillments?: OrderWithFulfillments;
 }
-interface DeleteFulfillmentRequest {
+export interface DeleteFulfillmentRequest {
     /**
      * Order ID.
      * @minLength 1
@@ -293,19 +293,19 @@ interface DeleteFulfillmentRequest {
      */
     fulfillmentId: string;
 }
-interface DeleteFulfillmentResponse {
+export interface DeleteFulfillmentResponse {
     /** Order ID and the order's associated fulfillments after deletion. */
     orderWithFulfillments?: OrderWithFulfillments;
 }
-interface BulkCreateFulfillmentRequest {
+export interface BulkCreateFulfillmentRequest {
     /**
-     * List of order IDs and their associated fulfillments' info.
+     * List of order IDs and their associated fulfillments.
      * @minSize 1
      * @maxSize 100
      */
     ordersWithFulfillments: BulkCreateOrderWithFulfillments[];
 }
-interface BulkCreateOrderWithFulfillments {
+export interface BulkCreateOrderWithFulfillments {
     /**
      * Order ID.
      * @minLength 1
@@ -318,21 +318,20 @@ interface BulkCreateOrderWithFulfillments {
      */
     fulfillments?: Fulfillment[];
 }
-interface BulkCreateFulfillmentResponse {
+export interface BulkCreateFulfillmentResponse {
     /** Items updated by bulk action. */
     results?: BulkOrderFulfillmentsResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface BulkOrderFulfillmentsResult {
+export interface BulkOrderFulfillmentsResult {
     /** Item metadata. */
     itemMetadata?: ItemMetadata;
-    /** List of order IDs and their associated fulfillments. */
     ordersWithFulfillments?: OrderWithFulfillments;
 }
-interface ItemMetadata {
+export 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. */
@@ -340,7 +339,7 @@ interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-interface ApplicationError {
+export interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -348,7 +347,7 @@ interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-interface BulkActionMetadata {
+export interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -356,7 +355,7 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -365,7 +364,7 @@ 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
@@ -399,34 +398,36 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
-    entity?: string;
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+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;
+    currentEntityAsJson?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
-    deletedEntity?: string | null;
+    deletedEntityAsJson?: string | null;
 }
-interface ActionEvent {
-    body?: string;
+export interface ActionEvent {
+    bodyAsJson?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -442,7 +443,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -467,7 +468,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -489,131 +490,10 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export 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 };

package/build/es/src/ecom-v1-fulfillments-order-fulfillments.types.js

@@ -0,0 +1,31 @@
+export var IdentityType;
+(function (IdentityType) {
+    IdentityType["UNSPECIFIED_IDENTITY_TYPE"] = "UNSPECIFIED_IDENTITY_TYPE";
+    /** Site member */
+    IdentityType["MEMBER"] = "MEMBER";
+    /** Contact */
+    IdentityType["CONTACT"] = "CONTACT";
+})(IdentityType || (IdentityType = {}));
+export var FulfillmentStatus;
+(function (FulfillmentStatus) {
+    /** None of the order items are fulfilled */
+    FulfillmentStatus["NOT_FULFILLED"] = "NOT_FULFILLED";
+    /**
+     * All of the order items are fulfilled
+     * Orders without shipping info are fulfilled automatically
+     */
+    FulfillmentStatus["FULFILLED"] = "FULFILLED";
+    /** Order is canceled */
+    FulfillmentStatus["CANCELED"] = "CANCELED";
+    /** Some, but not all of the order items are fulfilled */
+    FulfillmentStatus["PARTIALLY_FULFILLED"] = "PARTIALLY_FULFILLED";
+})(FulfillmentStatus || (FulfillmentStatus = {}));
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+//# sourceMappingURL=ecom-v1-fulfillments-order-fulfillments.types.js.map

package/build/es/src/ecom-v1-fulfillments-order-fulfillments.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecom-v1-fulfillments-order-fulfillments.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-fulfillments-order-fulfillments.types.ts"],"names":[],"mappings":"AA0KA,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,kBAAkB;IAClB,iCAAiB,CAAA;IACjB,cAAc;IACd,mCAAmB,CAAA;AACrB,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AAED,MAAM,CAAN,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,oDAA+B,CAAA;IAC/B;;;OAGG;IACH,4CAAuB,CAAA;IACvB,wBAAwB;IACxB,0CAAqB,CAAA;IACrB,yDAAyD;IACzD,gEAA2C,CAAA;AAC7C,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B;AAsVD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}