@wix/auto_sdk_pricing-plans_orders 1.0.116 → 1.0.118

package/build/cjs/index.typings.d.ts

@@ -591,7 +591,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
      * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;
@@ -1823,7 +1823,7 @@ interface EventMetadata extends BaseEventMetadata {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
      * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;
@@ -1847,6 +1847,8 @@ interface OrderCanceledEnvelope {
  * This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
  * + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
  * + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -1868,6 +1870,8 @@ interface OrderCreatedEnvelope {
 }
 /**
  * Triggered when an order is created.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -1889,6 +1893,8 @@ interface OrderStartDateChangedEnvelope {
 }
 /**
  * Triggered when an order's `startDate` is changed.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -1918,6 +1924,8 @@ interface OrderUpdatedEnvelope {
  * + End date of the order is postponed. Order End Date Postponed is also triggered
  * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
  * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -1943,6 +1951,8 @@ interface OrderAutoRenewCanceledEnvelope {
  * This webhook is *not* triggered in the following scenarios:
  * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
  * + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -1966,6 +1976,8 @@ interface OrderCycleStartedEnvelope {
  * Triggered at the start of a new payment cycle for an existing order.
  *
  * Not triggered at the initial start of an offline order.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -1987,6 +1999,8 @@ interface OrderEndDatePostponedEnvelope {
 }
 /**
  * Triggered when an order's `endDate` is postponed.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -2012,6 +2026,8 @@ interface OrderEndedEnvelope {
  * This webhook is triggered:
  * + When an order expires at the end of the current payment cycle.
  * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -2033,6 +2049,8 @@ interface OrderMarkedAsPaidEnvelope {
 }
 /**
  * Triggered when an offline order is marked as paid.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -2054,6 +2072,8 @@ interface OrderPausedEnvelope {
 }
 /**
  * Triggered when an order is paused.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -2079,6 +2099,8 @@ interface OrderPurchasedEnvelope {
  * + At least 1 order cycle payment is paid for.
  * + Offline order is created, even if not yet marked as paid.
  * + Free order is created.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -2100,6 +2122,8 @@ interface OrderResumedEnvelope {
 }
 /**
  * Triggered when a paused order is resumed.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders
@@ -2121,6 +2145,8 @@ interface OrderStartedEnvelope {
 }
 /**
  * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @permissionScope Read Orders