@wix/auto_sdk_ecom_order-fulfillments 1.0.17 → 1.0.19

package/build/internal/meta.d.mts

@@ -0,0 +1,258 @@
+import { o as ListFulfillmentsForSingleOrderRequest$1, L as ListFulfillmentsForSingleOrderResponse$1, p as ListFulfillmentsForMultipleOrdersRequest$1, a as ListFulfillmentsForMultipleOrdersResponse$1, q as CreateFulfillmentRequest$1, C as CreateFulfillmentResponse$1, r as UpdateFulfillmentRequest$1, s as UpdateFulfillmentResponse$1, t as DeleteFulfillmentRequest$1, c as DeleteFulfillmentResponse$1, u as BulkCreateFulfillmentRequest$1, d as BulkCreateFulfillmentResponse$1 } from './ecom-v1-fulfillments-order-fulfillments.universal-DOM-x30R.mjs';
+
+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. */
+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 */
+interface FulfillmentFulfillmentInfoOneOf {
+    /** Tracking info. */
+    trackingInfo?: FulfillmentTrackingInfo;
+    /** Custom fulfillment info. */
+    customInfo?: CustomFulfillmentInfo;
+}
+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;
+}
+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;
+}
+interface CustomFulfillmentInfo {
+    /**
+     * Custom fulfillment info in key:value form.
+     * @maxSize 100
+     */
+    fieldsData?: Record<string, string>;
+}
+interface ListFulfillmentsForSingleOrderRequest {
+    /**
+     * Order ID for which to retrieve fulfillments.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId: string;
+}
+interface ListFulfillmentsForSingleOrderResponse {
+    /** List of fulfillments associated with the order. */
+    orderWithFulfillments?: OrderWithFulfillments;
+}
+interface ListFulfillmentsForMultipleOrdersRequest {
+    /**
+     * List of order IDs for which to retrieve fulfillments.
+     * @minSize 1
+     * @maxSize 100
+     */
+    orderIds: string[];
+}
+interface ListFulfillmentsForMultipleOrdersResponse {
+    /** List of order IDs and their associated fulfillments. */
+    ordersWithFulfillments?: OrderWithFulfillments[];
+}
+interface CreateFulfillmentRequest {
+    /** Order ID. */
+    orderId: string;
+    /** Fulfillment info. */
+    fulfillment: Fulfillment;
+}
+interface CreateFulfillmentResponse {
+    /** Order ID and the orders' fulfillments. */
+    orderWithFulfillments?: OrderWithFulfillments;
+    /** ID of created fulfillment. */
+    fulfillmentId?: string;
+}
+interface UpdateFulfillmentRequest {
+    /** Order ID. */
+    orderId: string;
+    /** Fulfillment info to update. */
+    fulfillment?: Fulfillment;
+}
+interface UpdateFulfillmentResponse {
+    /** Order ID and the orders' associated fulfillments after update. */
+    orderWithFulfillments?: OrderWithFulfillments;
+}
+interface DeleteFulfillmentRequest {
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId: string;
+    /**
+     * ID of the fulfillment to delete.
+     * @format GUID
+     */
+    fulfillmentId: string;
+}
+interface DeleteFulfillmentResponse {
+    /** Order ID and the order's associated fulfillments after deletion. */
+    orderWithFulfillments?: OrderWithFulfillments;
+}
+interface BulkCreateFulfillmentRequest {
+    /**
+     * List of order IDs and their associated fulfillments.
+     * @minSize 1
+     * @maxSize 100
+     */
+    ordersWithFulfillments: BulkCreateOrderWithFulfillments[];
+}
+interface BulkCreateOrderWithFulfillments {
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId?: string;
+    /**
+     * Fulfillments associated with the order.
+     * @minSize 1
+     */
+    fulfillments?: Fulfillment[];
+}
+interface BulkCreateFulfillmentResponse {
+    /** Items updated by bulk action. */
+    results?: BulkOrderFulfillmentsResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkOrderFulfillmentsResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+    ordersWithFulfillments?: OrderWithFulfillments;
+}
+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;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+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;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function listFulfillmentsForSingleOrder(): __PublicMethodMetaInfo<'GET', {
+    orderId: string;
+}, ListFulfillmentsForSingleOrderRequest$1, ListFulfillmentsForSingleOrderRequest, ListFulfillmentsForSingleOrderResponse$1, ListFulfillmentsForSingleOrderResponse>;
+declare function listFulfillmentsForMultipleOrders(): __PublicMethodMetaInfo<'POST', {}, ListFulfillmentsForMultipleOrdersRequest$1, ListFulfillmentsForMultipleOrdersRequest, ListFulfillmentsForMultipleOrdersResponse$1, ListFulfillmentsForMultipleOrdersResponse>;
+declare function createFulfillment(): __PublicMethodMetaInfo<'POST', {
+    orderId: string;
+}, CreateFulfillmentRequest$1, CreateFulfillmentRequest, CreateFulfillmentResponse$1, CreateFulfillmentResponse>;
+declare function updateFulfillment(): __PublicMethodMetaInfo<'PATCH', {
+    fulfillmentId: string;
+    orderId: string;
+}, UpdateFulfillmentRequest$1, UpdateFulfillmentRequest, UpdateFulfillmentResponse$1, UpdateFulfillmentResponse>;
+declare function deleteFulfillment(): __PublicMethodMetaInfo<'DELETE', {
+    fulfillmentId: string;
+    orderId: string;
+}, DeleteFulfillmentRequest$1, DeleteFulfillmentRequest, DeleteFulfillmentResponse$1, DeleteFulfillmentResponse>;
+declare function bulkCreateFulfillments(): __PublicMethodMetaInfo<'POST', {}, BulkCreateFulfillmentRequest$1, BulkCreateFulfillmentRequest, BulkCreateFulfillmentResponse$1, BulkCreateFulfillmentResponse>;
+
+export { type __PublicMethodMetaInfo, bulkCreateFulfillments, createFulfillment, deleteFulfillment, listFulfillmentsForMultipleOrders, listFulfillmentsForSingleOrder, updateFulfillment };

package/build/internal/meta.d.ts

@@ -0,0 +1,258 @@
+import { o as ListFulfillmentsForSingleOrderRequest$1, L as ListFulfillmentsForSingleOrderResponse$1, p as ListFulfillmentsForMultipleOrdersRequest$1, a as ListFulfillmentsForMultipleOrdersResponse$1, q as CreateFulfillmentRequest$1, C as CreateFulfillmentResponse$1, r as UpdateFulfillmentRequest$1, s as UpdateFulfillmentResponse$1, t as DeleteFulfillmentRequest$1, c as DeleteFulfillmentResponse$1, u as BulkCreateFulfillmentRequest$1, d as BulkCreateFulfillmentResponse$1 } from './ecom-v1-fulfillments-order-fulfillments.universal-DOM-x30R.js';
+
+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. */
+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 */
+interface FulfillmentFulfillmentInfoOneOf {
+    /** Tracking info. */
+    trackingInfo?: FulfillmentTrackingInfo;
+    /** Custom fulfillment info. */
+    customInfo?: CustomFulfillmentInfo;
+}
+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;
+}
+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;
+}
+interface CustomFulfillmentInfo {
+    /**
+     * Custom fulfillment info in key:value form.
+     * @maxSize 100
+     */
+    fieldsData?: Record<string, string>;
+}
+interface ListFulfillmentsForSingleOrderRequest {
+    /**
+     * Order ID for which to retrieve fulfillments.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId: string;
+}
+interface ListFulfillmentsForSingleOrderResponse {
+    /** List of fulfillments associated with the order. */
+    orderWithFulfillments?: OrderWithFulfillments;
+}
+interface ListFulfillmentsForMultipleOrdersRequest {
+    /**
+     * List of order IDs for which to retrieve fulfillments.
+     * @minSize 1
+     * @maxSize 100
+     */
+    orderIds: string[];
+}
+interface ListFulfillmentsForMultipleOrdersResponse {
+    /** List of order IDs and their associated fulfillments. */
+    ordersWithFulfillments?: OrderWithFulfillments[];
+}
+interface CreateFulfillmentRequest {
+    /** Order ID. */
+    orderId: string;
+    /** Fulfillment info. */
+    fulfillment: Fulfillment;
+}
+interface CreateFulfillmentResponse {
+    /** Order ID and the orders' fulfillments. */
+    orderWithFulfillments?: OrderWithFulfillments;
+    /** ID of created fulfillment. */
+    fulfillmentId?: string;
+}
+interface UpdateFulfillmentRequest {
+    /** Order ID. */
+    orderId: string;
+    /** Fulfillment info to update. */
+    fulfillment?: Fulfillment;
+}
+interface UpdateFulfillmentResponse {
+    /** Order ID and the orders' associated fulfillments after update. */
+    orderWithFulfillments?: OrderWithFulfillments;
+}
+interface DeleteFulfillmentRequest {
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId: string;
+    /**
+     * ID of the fulfillment to delete.
+     * @format GUID
+     */
+    fulfillmentId: string;
+}
+interface DeleteFulfillmentResponse {
+    /** Order ID and the order's associated fulfillments after deletion. */
+    orderWithFulfillments?: OrderWithFulfillments;
+}
+interface BulkCreateFulfillmentRequest {
+    /**
+     * List of order IDs and their associated fulfillments.
+     * @minSize 1
+     * @maxSize 100
+     */
+    ordersWithFulfillments: BulkCreateOrderWithFulfillments[];
+}
+interface BulkCreateOrderWithFulfillments {
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId?: string;
+    /**
+     * Fulfillments associated with the order.
+     * @minSize 1
+     */
+    fulfillments?: Fulfillment[];
+}
+interface BulkCreateFulfillmentResponse {
+    /** Items updated by bulk action. */
+    results?: BulkOrderFulfillmentsResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkOrderFulfillmentsResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+    ordersWithFulfillments?: OrderWithFulfillments;
+}
+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;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+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;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function listFulfillmentsForSingleOrder(): __PublicMethodMetaInfo<'GET', {
+    orderId: string;
+}, ListFulfillmentsForSingleOrderRequest$1, ListFulfillmentsForSingleOrderRequest, ListFulfillmentsForSingleOrderResponse$1, ListFulfillmentsForSingleOrderResponse>;
+declare function listFulfillmentsForMultipleOrders(): __PublicMethodMetaInfo<'POST', {}, ListFulfillmentsForMultipleOrdersRequest$1, ListFulfillmentsForMultipleOrdersRequest, ListFulfillmentsForMultipleOrdersResponse$1, ListFulfillmentsForMultipleOrdersResponse>;
+declare function createFulfillment(): __PublicMethodMetaInfo<'POST', {
+    orderId: string;
+}, CreateFulfillmentRequest$1, CreateFulfillmentRequest, CreateFulfillmentResponse$1, CreateFulfillmentResponse>;
+declare function updateFulfillment(): __PublicMethodMetaInfo<'PATCH', {
+    fulfillmentId: string;
+    orderId: string;
+}, UpdateFulfillmentRequest$1, UpdateFulfillmentRequest, UpdateFulfillmentResponse$1, UpdateFulfillmentResponse>;
+declare function deleteFulfillment(): __PublicMethodMetaInfo<'DELETE', {
+    fulfillmentId: string;
+    orderId: string;
+}, DeleteFulfillmentRequest$1, DeleteFulfillmentRequest, DeleteFulfillmentResponse$1, DeleteFulfillmentResponse>;
+declare function bulkCreateFulfillments(): __PublicMethodMetaInfo<'POST', {}, BulkCreateFulfillmentRequest$1, BulkCreateFulfillmentRequest, BulkCreateFulfillmentResponse$1, BulkCreateFulfillmentResponse>;
+
+export { type __PublicMethodMetaInfo, bulkCreateFulfillments, createFulfillment, deleteFulfillment, listFulfillmentsForMultipleOrders, listFulfillmentsForSingleOrder, updateFulfillment };