@wix/auto_sdk_ecom_order-invoices 1.0.7 → 1.0.8

package/build/{ecom-orders-v1-invoice-order-invoices.universal-MRNaa-Xt.d.mts → cjs/src/ecom-orders-v1-invoice-order-invoices.types.d.ts}

@@ -1,10 +1,10 @@
-interface Invoice {
+export interface Invoice {
     /** Invoice ID. */
-    _id?: string;
+    id?: string;
     /** ID of the app that set the invoice. */
     appId?: string;
 }
-interface ListInvoicesForSingleOrderRequest {
+export interface ListInvoicesForSingleOrderRequest {
     /**
      * Order ID.
      * @minLength 1
@@ -12,11 +12,11 @@ interface ListInvoicesForSingleOrderRequest {
      */
     orderId?: string;
 }
-interface ListInvoicesForSingleOrderResponse {
+export interface ListInvoicesForSingleOrderResponse {
     /** List of invoices. */
     invoices?: Invoice[];
 }
-interface ListInvoicesForMultipleOrdersRequest {
+export interface ListInvoicesForMultipleOrdersRequest {
     /**
      * Order IDs for which to retrieve invoices.
      * @maxSize 100
@@ -25,11 +25,11 @@ interface ListInvoicesForMultipleOrdersRequest {
      */
     orderIds: string[];
 }
-interface ListInvoicesForMultipleOrdersResponse {
+export interface ListInvoicesForMultipleOrdersResponse {
     /** List of order IDs and their associated invoices. */
     invoicesForOrder?: InvoicesForOrder[];
 }
-interface InvoicesForOrder {
+export interface InvoicesForOrder {
     /** Order ID. */
     orderId?: string;
     /**
@@ -38,7 +38,7 @@ interface InvoicesForOrder {
      */
     invoicesInfo?: Invoice[];
 }
-interface GenerateInvoiceRequest {
+export interface GenerateInvoiceRequest {
     /**
      * Order ID.
      * @minLength 1
@@ -46,11 +46,11 @@ interface GenerateInvoiceRequest {
      */
     orderId: string;
 }
-interface GenerateInvoiceResponse {
+export interface GenerateInvoiceResponse {
     /** Invoice ID. */
     invoiceId?: string;
 }
-interface BulkGenerateInvoicesRequest {
+export interface BulkGenerateInvoicesRequest {
     /**
      * Order IDs.
      * @minSize 1
@@ -60,17 +60,17 @@ interface BulkGenerateInvoicesRequest {
      */
     orderIds: string[];
 }
-interface BulkGenerateInvoicesResponse {
+export interface BulkGenerateInvoicesResponse {
     results?: BulkInvoiceResult[];
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface BulkInvoiceResult {
+export interface BulkInvoiceResult {
     itemMetadata?: ItemMetadata;
     item?: InvoiceForOrder;
 }
-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. */
@@ -78,7 +78,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. */
@@ -86,13 +86,13 @@ interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-interface InvoiceForOrder {
+export interface InvoiceForOrder {
     /** Order ID. */
     orderId?: string;
     /** Invoice ID. */
     invoiceId?: string;
 }
-interface BulkActionMetadata {
+export interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -100,7 +100,7 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-interface AddInvoiceToOrderRequest {
+export interface AddInvoiceToOrderRequest {
     /**
      * Order ID.
      * @minLength 1
@@ -110,11 +110,11 @@ interface AddInvoiceToOrderRequest {
     /** Invoice info. */
     invoiceInfo: Invoice;
 }
-interface AddInvoiceToOrderResponse {
+export interface AddInvoiceToOrderResponse {
     /** List of order invoices. */
     orderInvoices?: Invoice[];
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -123,7 +123,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
@@ -157,36 +157,38 @@ 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 Empty {
+export interface Empty {
 }
-interface GetOrderInvoiceRequest {
+export interface GetOrderInvoiceRequest {
     /**
      * Invoice ID.
      * @minLength 1
@@ -194,7 +196,7 @@ interface GetOrderInvoiceRequest {
      */
     invoiceId?: string;
 }
-interface GetOrderInvoiceResponse {
+export interface GetOrderInvoiceResponse {
     /**
      * Order ID.
      * @minLength 1
@@ -204,7 +206,7 @@ interface GetOrderInvoiceResponse {
     /** Invoice info. */
     invoiceInfo?: Invoice;
 }
-interface GenerateInvoiceWithNumberRequest {
+export interface GenerateInvoiceWithNumberRequest {
     /**
      * Order ID.
      * @minLength 1
@@ -219,7 +221,7 @@ interface GenerateInvoiceWithNumberRequest {
     /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
     issueDate?: Date | null;
 }
-interface GenerateInvoiceWithNumberResponse {
+export interface GenerateInvoiceWithNumberResponse {
     /**
      * Invoice ID.
      * @minLength 1
@@ -227,7 +229,7 @@ interface GenerateInvoiceWithNumberResponse {
      */
     invoiceId?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -243,7 +245,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
@@ -268,7 +270,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
@@ -290,12 +292,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"
 }
-
-export { type ApplicationError as A, type BulkGenerateInvoicesRequest as B, type DomainEvent as D, type EntityCreatedEvent as E, type GenerateInvoiceRequest as G, type Invoice as I, type ListInvoicesForMultipleOrdersResponse as L, type MessageEnvelope as M, type RestoreInfo as R, WebhookIdentityType as W, type ListInvoicesForSingleOrderRequest as a, type ListInvoicesForSingleOrderResponse as b, type ListInvoicesForMultipleOrdersRequest as c, type InvoicesForOrder as d, type GenerateInvoiceResponse as e, type BulkGenerateInvoicesResponse as f, type BulkInvoiceResult as g, type ItemMetadata as h, type InvoiceForOrder as i, type BulkActionMetadata as j, type AddInvoiceToOrderRequest as k, type AddInvoiceToOrderResponse as l, type DomainEventBodyOneOf as m, type EntityUpdatedEvent as n, type EntityDeletedEvent as o, type ActionEvent as p, type Empty as q, type GetOrderInvoiceRequest as r, type GetOrderInvoiceResponse as s, type GenerateInvoiceWithNumberRequest as t, type GenerateInvoiceWithNumberResponse as u, type IdentificationData as v, type IdentificationDataIdOneOf as w };

package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.types.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = void 0;
+var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
+//# sourceMappingURL=ecom-orders-v1-invoice-order-invoices.types.js.map

package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecom-orders-v1-invoice-order-invoices.types.js","sourceRoot":"","sources":["../../../src/ecom-orders-v1-invoice-order-invoices.types.ts"],"names":[],"mappings":";;;AAqUA,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}

package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.universal.d.ts

@@ -0,0 +1,335 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface Invoice {
+    /** Invoice ID. */
+    _id?: string;
+    /** ID of the app that set the invoice. */
+    appId?: string;
+}
+export interface ListInvoicesForSingleOrderRequest {
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId?: string;
+}
+export interface ListInvoicesForSingleOrderResponse {
+    /** List of invoices. */
+    invoices?: Invoice[];
+}
+export interface ListInvoicesForMultipleOrdersRequest {
+    /**
+     * Order IDs for which to retrieve invoices.
+     * @maxSize 100
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderIds: string[];
+}
+export interface ListInvoicesForMultipleOrdersResponse {
+    /** List of order IDs and their associated invoices. */
+    invoicesForOrder?: InvoicesForOrder[];
+}
+export interface InvoicesForOrder {
+    /** Order ID. */
+    orderId?: string;
+    /**
+     * Invoices info.
+     * @maxSize 300
+     */
+    invoicesInfo?: Invoice[];
+}
+export interface GenerateInvoiceRequest {
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId: string;
+}
+export interface GenerateInvoiceResponse {
+    /** Invoice ID. */
+    invoiceId?: string;
+}
+export interface BulkGenerateInvoicesRequest {
+    /**
+     * Order IDs.
+     * @minSize 1
+     * @maxSize 300
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderIds: string[];
+}
+export interface BulkGenerateInvoicesResponse {
+    results?: BulkInvoiceResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkInvoiceResult {
+    itemMetadata?: ItemMetadata;
+    item?: InvoiceForOrder;
+}
+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 InvoiceForOrder {
+    /** Order ID. */
+    orderId?: string;
+    /** Invoice ID. */
+    invoiceId?: string;
+}
+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 AddInvoiceToOrderRequest {
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId: string;
+    /** Invoice info. */
+    invoiceInfo: Invoice;
+}
+export interface AddInvoiceToOrderResponse {
+    /** List of order invoices. */
+    orderInvoices?: Invoice[];
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * 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;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface Empty {
+}
+export interface GetOrderInvoiceRequest {
+    /**
+     * Invoice ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    invoiceId?: string;
+}
+export interface GetOrderInvoiceResponse {
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId?: string;
+    /** Invoice info. */
+    invoiceInfo?: Invoice;
+}
+export interface GenerateInvoiceWithNumberRequest {
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId?: string;
+    /**
+     * @minLength 1
+     * @maxLength 11
+     */
+    invoiceNumber?: string;
+    /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
+    issueDate?: Date | null;
+}
+export interface GenerateInvoiceWithNumberResponse {
+    /**
+     * Invoice ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    invoiceId?: string;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+type InvoiceNonNullablePaths = `_id` | `appId`;
+/**
+ * Retrieves the IDs of invoices associated with all specified orders.
+ *
+ *
+ * The `listInvoicesForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
+ * @param orderIds - Order IDs for which to retrieve invoices.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField orderIds
+ * @permissionId ECOM.READ_INVOICES
+ * @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 Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionScope Picasso private app mega scope
+ * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn com.wix.ecom.orders.invoices.v1.Invoices.ListInvoicesForMultipleOrders
+ */
+export declare function listInvoicesForMultipleOrders(orderIds: string[]): Promise<NonNullablePaths<ListInvoicesForMultipleOrdersResponse, `invoicesForOrder` | `invoicesForOrder.${number}.orderId` | {
+    [P in InvoiceNonNullablePaths]: `invoicesForOrder.${number}.invoicesInfo.${number}.${P}`;
+}[InvoiceNonNullablePaths]>>;
+export {};