@wix/ecom 1.0.511 → 1.0.512

package/build/cjs/src/ecom-v1-order-transactions.http.d.ts

@@ -4,14 +4,14 @@ import { AddPaymentsRequest, AddPaymentsResponse, BulkUpdatePaymentStatusesReque
  * Retrieves information about payments and refunds associated with a specified order.
  *
  *
- * The `ListTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
+ * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
  */
 export declare function listTransactionsForSingleOrder(payload: ListTransactionsForSingleOrderRequest): RequestOptionsFactory<ListTransactionsForSingleOrderResponse & ListTransactionsForSingleOrderResponseNonNullableFields>;
 /**
  * Retrieves information about payments and refunds associated with all specified orders.
  *
  *
- * The `ListTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
+ * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
  */
 export declare function listTransactionsForMultipleOrders(payload: ListTransactionsForMultipleOrdersRequest): RequestOptionsFactory<ListTransactionsForMultipleOrdersResponse & ListTransactionsForMultipleOrdersResponseNonNullableFields>;
 /**
@@ -27,13 +27,13 @@ export declare function addPayments(payload: AddPaymentsRequest): RequestOptions
  * Updates the status of an order's payment.
  *
  *
- * The `UpdatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
+ * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
  */
 export declare function updatePaymentStatus(payload: UpdatePaymentStatusRequest): RequestOptionsFactory<UpdatePaymentStatusResponse & UpdatePaymentStatusResponseNonNullableFields>;
 /**
  * Updates multiple order payments with a specified status.
  *
  *
- * The `BulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
+ * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
  */
 export declare function bulkUpdatePaymentStatuses(payload: BulkUpdatePaymentStatusesRequest): RequestOptionsFactory<BulkUpdatePaymentStatusesResponse & BulkUpdatePaymentStatusesResponseNonNullableFields>;

package/build/cjs/src/ecom-v1-order-transactions.http.js

@@ -27,7 +27,7 @@ function resolveComWixEcomOrdersPaymentsV1PaymentsUrl(opts) {
  * Retrieves information about payments and refunds associated with a specified order.
  *
  *
- * The `ListTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
+ * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
  */
 function listTransactionsForSingleOrder(payload) {
     function __listTransactionsForSingleOrder({ host }) {
@@ -61,7 +61,7 @@ exports.listTransactionsForSingleOrder = listTransactionsForSingleOrder;
  * Retrieves information about payments and refunds associated with all specified orders.
  *
  *
- * The `ListTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
+ * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
  */
 function listTransactionsForMultipleOrders(payload) {
     function __listTransactionsForMultipleOrders({ host }) {
@@ -140,7 +140,7 @@ exports.addPayments = addPayments;
  * Updates the status of an order's payment.
  *
  *
- * The `UpdatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
+ * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
  */
 function updatePaymentStatus(payload) {
     function __updatePaymentStatus({ host }) {
@@ -180,7 +180,7 @@ exports.updatePaymentStatus = updatePaymentStatus;
  * Updates multiple order payments with a specified status.
  *
  *
- * The `BulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
+ * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
  */
 function bulkUpdatePaymentStatuses(payload) {
     function __bulkUpdatePaymentStatuses({ host }) {

package/build/cjs/src/ecom-v1-order-transactions.universal.d.ts

@@ -1573,7 +1573,7 @@ export declare const onOrderTransactionsUpdated: EventDefinition<DomainActionEve
  * Retrieves information about payments and refunds associated with a specified order.
  *
  *
- * The `ListTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
+ * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
  * @param orderId - Order ID.
  * @public
  * @documentationMaturity preview
@@ -1597,7 +1597,7 @@ export declare function listTransactionsForSingleOrder(orderId: string): Promise
  * Retrieves information about payments and refunds associated with all specified orders.
  *
  *
- * The `ListTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
+ * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
  * @param orderIds - Order IDs for which to retrieve transactions.
  * @public
  * @documentationMaturity preview
@@ -1645,7 +1645,7 @@ export declare function addPayments(orderId: string, payments: Payment[]): Promi
  * Updates the status of an order's payment.
  *
  *
- * The `UpdatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
+ * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
  * @public
  * @documentationMaturity preview
  * @requiredField identifiers
@@ -1674,7 +1674,7 @@ export interface UpdatePaymentStatusOptions {
  * Updates multiple order payments with a specified status.
  *
  *
- * The `BulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
+ * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
  * @param paymentAndOrderIds - Order and payment IDs for which to update payment status.
  * @public
  * @documentationMaturity preview

package/build/cjs/src/ecom-v1-order-transactions.universal.js

@@ -270,7 +270,7 @@ exports.onOrderTransactionsUpdated = (0, sdk_types_1.EventDefinition)('wix.ecom.
  * Retrieves information about payments and refunds associated with a specified order.
  *
  *
- * The `ListTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
+ * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
  * @param orderId - Order ID.
  * @public
  * @documentationMaturity preview
@@ -338,7 +338,7 @@ exports.listTransactionsForSingleOrder = listTransactionsForSingleOrder;
  * Retrieves information about payments and refunds associated with all specified orders.
  *
  *
- * The `ListTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
+ * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
  * @param orderIds - Order IDs for which to retrieve transactions.
  * @public
  * @documentationMaturity preview
@@ -474,7 +474,7 @@ exports.addPayments = addPayments;
  * Updates the status of an order's payment.
  *
  *
- * The `UpdatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
+ * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
  * @public
  * @documentationMaturity preview
  * @requiredField identifiers
@@ -545,7 +545,7 @@ exports.updatePaymentStatus = updatePaymentStatus;
  * Updates multiple order payments with a specified status.
  *
  *
- * The `BulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
+ * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
  * @param paymentAndOrderIds - Order and payment IDs for which to update payment status.
  * @public
  * @documentationMaturity preview

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

@@ -242,9 +242,9 @@ export interface CatalogReference {
     /**
      * Additional item details in key:value pairs.
      *
-     * Use this optional field to specify a variant of the item or add custom details. There are several ways to use `options`:
-     * + Pass specific information about the item variant in this field. For example, size and color of an item of clothing: `"options": {"Size": "M", "Color": "Red"}`.
-     * + Create a separate API for creating item variants that stores the details and generates a unique ID for each item variant. Then pass only the variant ID in this field. For example: `"options": {"variantId": "<VARIANT_ID>"}`.
+     * Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
+     *
+     * For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).
      */
     options?: Record<string, any> | null;
 }

package/build/es/src/ecom-v1-order-transactions.http.d.ts

@@ -4,14 +4,14 @@ import { AddPaymentsRequest, AddPaymentsResponse, BulkUpdatePaymentStatusesReque
  * Retrieves information about payments and refunds associated with a specified order.
  *
  *
- * The `ListTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
+ * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
  */
 export declare function listTransactionsForSingleOrder(payload: ListTransactionsForSingleOrderRequest): RequestOptionsFactory<ListTransactionsForSingleOrderResponse & ListTransactionsForSingleOrderResponseNonNullableFields>;
 /**
  * Retrieves information about payments and refunds associated with all specified orders.
  *
  *
- * The `ListTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
+ * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
  */
 export declare function listTransactionsForMultipleOrders(payload: ListTransactionsForMultipleOrdersRequest): RequestOptionsFactory<ListTransactionsForMultipleOrdersResponse & ListTransactionsForMultipleOrdersResponseNonNullableFields>;
 /**
@@ -27,13 +27,13 @@ export declare function addPayments(payload: AddPaymentsRequest): RequestOptions
  * Updates the status of an order's payment.
  *
  *
- * The `UpdatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
+ * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
  */
 export declare function updatePaymentStatus(payload: UpdatePaymentStatusRequest): RequestOptionsFactory<UpdatePaymentStatusResponse & UpdatePaymentStatusResponseNonNullableFields>;
 /**
  * Updates multiple order payments with a specified status.
  *
  *
- * The `BulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
+ * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
  */
 export declare function bulkUpdatePaymentStatuses(payload: BulkUpdatePaymentStatusesRequest): RequestOptionsFactory<BulkUpdatePaymentStatusesResponse & BulkUpdatePaymentStatusesResponseNonNullableFields>;

package/build/es/src/ecom-v1-order-transactions.http.js

@@ -24,7 +24,7 @@ function resolveComWixEcomOrdersPaymentsV1PaymentsUrl(opts) {
  * Retrieves information about payments and refunds associated with a specified order.
  *
  *
- * The `ListTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
+ * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
  */
 export function listTransactionsForSingleOrder(payload) {
     function __listTransactionsForSingleOrder({ host }) {
@@ -57,7 +57,7 @@ export function listTransactionsForSingleOrder(payload) {
  * Retrieves information about payments and refunds associated with all specified orders.
  *
  *
- * The `ListTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
+ * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
  */
 export function listTransactionsForMultipleOrders(payload) {
     function __listTransactionsForMultipleOrders({ host }) {
@@ -134,7 +134,7 @@ export function addPayments(payload) {
  * Updates the status of an order's payment.
  *
  *
- * The `UpdatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
+ * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
  */
 export function updatePaymentStatus(payload) {
     function __updatePaymentStatus({ host }) {
@@ -173,7 +173,7 @@ export function updatePaymentStatus(payload) {
  * Updates multiple order payments with a specified status.
  *
  *
- * The `BulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
+ * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
  */
 export function bulkUpdatePaymentStatuses(payload) {
     function __bulkUpdatePaymentStatuses({ host }) {

package/build/es/src/ecom-v1-order-transactions.universal.d.ts

@@ -1573,7 +1573,7 @@ export declare const onOrderTransactionsUpdated: EventDefinition<DomainActionEve
  * Retrieves information about payments and refunds associated with a specified order.
  *
  *
- * The `ListTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
+ * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
  * @param orderId - Order ID.
  * @public
  * @documentationMaturity preview
@@ -1597,7 +1597,7 @@ export declare function listTransactionsForSingleOrder(orderId: string): Promise
  * Retrieves information about payments and refunds associated with all specified orders.
  *
  *
- * The `ListTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
+ * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
  * @param orderIds - Order IDs for which to retrieve transactions.
  * @public
  * @documentationMaturity preview
@@ -1645,7 +1645,7 @@ export declare function addPayments(orderId: string, payments: Payment[]): Promi
  * Updates the status of an order's payment.
  *
  *
- * The `UpdatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
+ * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
  * @public
  * @documentationMaturity preview
  * @requiredField identifiers
@@ -1674,7 +1674,7 @@ export interface UpdatePaymentStatusOptions {
  * Updates multiple order payments with a specified status.
  *
  *
- * The `BulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
+ * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
  * @param paymentAndOrderIds - Order and payment IDs for which to update payment status.
  * @public
  * @documentationMaturity preview

package/build/es/src/ecom-v1-order-transactions.universal.js

@@ -244,7 +244,7 @@ export const onOrderTransactionsUpdated = EventDefinition('wix.ecom.v1.order_tra
  * Retrieves information about payments and refunds associated with a specified order.
  *
  *
- * The `ListTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
+ * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
  * @param orderId - Order ID.
  * @public
  * @documentationMaturity preview
@@ -311,7 +311,7 @@ export function listTransactionsForSingleOrder(orderId) {
  * Retrieves information about payments and refunds associated with all specified orders.
  *
  *
- * The `ListTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
+ * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
  * @param orderIds - Order IDs for which to retrieve transactions.
  * @public
  * @documentationMaturity preview
@@ -445,7 +445,7 @@ export function addPayments(orderId, payments) {
  * Updates the status of an order's payment.
  *
  *
- * The `UpdatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
+ * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
  * @public
  * @documentationMaturity preview
  * @requiredField identifiers
@@ -515,7 +515,7 @@ export function updatePaymentStatus(identifiers, options) {
  * Updates multiple order payments with a specified status.
  *
  *
- * The `BulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
+ * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
  * @param paymentAndOrderIds - Order and payment IDs for which to update payment status.
  * @public
  * @documentationMaturity preview

package/build/es/src/ecom-v1-order.universal.d.ts

@@ -242,9 +242,9 @@ export interface CatalogReference {
     /**
      * Additional item details in key:value pairs.
      *
-     * Use this optional field to specify a variant of the item or add custom details. There are several ways to use `options`:
-     * + Pass specific information about the item variant in this field. For example, size and color of an item of clothing: `"options": {"Size": "M", "Color": "Red"}`.
-     * + Create a separate API for creating item variants that stores the details and generates a unique ID for each item variant. Then pass only the variant ID in this field. For example: `"options": {"variantId": "<VARIANT_ID>"}`.
+     * Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
+     *
+     * For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).
      */
     options?: Record<string, any> | null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/ecom",
-  "version": "1.0.511",
+  "version": "1.0.512",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -35,5 +35,5 @@
       "groupId": "com.wixpress.public-sdk-autogen"
     }
   },
-  "falconPackageHash": "d07359a3ded85c9ff00f3ac97511bfec8b631570b7f1cbb7e73edd01"
+  "falconPackageHash": "6d314fb821b72e1e7642bccc19e7e42e6421e5823b4dbbfc55ecde4d"
 }