@wix/packages 1.0.4 → 1.0.5

package/type-bundles/context.bundle.d.ts

@@ -1,3 +1,1322 @@
+/**
+ * A package is group of instances of Wix services that a reseller offers to a
+ * customer as part of a single transaction.
+ */
+interface Package {
+    /**
+     * Package ID.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Wix account ID. See
+     * [Account Level APIs](https://dev.wix.com/api/rest/account-level-apis/about-account-level-apis)
+     * for more details.
+     * @readonly
+     */
+    accountId?: string;
+    /**
+     * External reference. For example, an external subscription ID.
+     * This field isn't validated by Wix.
+     *
+     * Max: 100 characters
+     */
+    externalId?: string | null;
+    /**
+     * Product instances that are included in the package.
+     *
+     * Min: 1 product instance
+     * Max: 1000 product instances
+     */
+    productInstances?: ProductInstance[];
+    /**
+     * Date and time the package was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the package was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Revision number of the `Package` object .
+     * The `Package` object is only modified when the specified number
+     * matches the latest revision.
+     * @readonly
+     */
+    revision?: string | null;
+}
+/**
+ * A product instance is a specific instance of a Wix service that a reseller
+ * offers to one of their customers.
+ */
+interface ProductInstance extends ProductInstanceContractDetailsOneOf {
+    /** Billing information for the contract between the reseller and Wix. */
+    billingInfo?: ProductInstanceCycle;
+    /**
+     * ID of the instance of the resold Wix service. **Note:** Differs from the
+     * `catalogProductId`. Allows you to identify different instances of the same
+     * product in a package.
+     * @readonly
+     */
+    instanceId?: string;
+    /**
+     * ID of the Wix site that the product instance is assigned to.
+     * See the [Query Sites API](https://dev.wix.com/api/rest/account-level-apis/sites/query-sites)
+     * for more information.
+     */
+    siteId?: string | null;
+    /**
+     * Product ID, as defined in the Wix Premium Product Catalog.
+     * Contact the [Wix B2B sales team](mailto:bizdev@wix.com)
+     * for more details about available Wix services.
+     */
+    catalogProductId?: string;
+    /**
+     * Status of the product instance.
+     *
+     * + `PENDING`: The product instance isn't yet available to the customer.
+     * + `ENABLED`: The customer can use the product instance.
+     * + `CANCELED`: The product instance isn't any longer available to the customer.
+     * + `FAILED`: The product instance couldn't be delivered successfully and has never been available to the customer.
+     * + `AWAITING_ACTION`: The product instance isn't yet available to the customer, because an external provider or the customer must take an action.
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * Failure object. Only present for status `FAILED`. Describes why the product instance `FAILED`.
+     * @readonly
+     */
+    failure?: FailureReason;
+    /**
+     * Date and time the product instance was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the product instance was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Two-letter country code in
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+     * format. Specifies where customers can claim vouchers that may come with the
+     * product. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) to get more
+     * information about vouchers and supported locations.
+     */
+    countryCode?: string | null;
+    /**
+     * Date and time the product instance expires in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * Used only for instances that don't auto renew at the end of the current billing cycle.
+     * @readonly
+     */
+    expirationDate?: Date;
+    /**
+     * Discount code indicating that the reseller provisioned the product instance
+     * during a sale. Wix doesn't guarantee that a discount code reduces the
+     * price between Wix and the reseller, even when it's valid. Contact the
+     * [Wix B2B sales team](mailto:bizdev@wix.com) for more information.
+     *
+     * Max: 25 characters
+     */
+    discountCode?: string | null;
+    /**
+     * ID of a different product instance that you can use to offer your customers
+     * time-limited free access to an additional product or service. For example,
+     * Wix offers a 1-year free domain registration to all customers who purchase a
+     * Premium plan. The referenced product instance must have either status `"PENDING"` or
+     * `"ACTIVE"`. You can use each product instance only a single time as reference
+     * instance.
+     */
+    referenceProductInstanceId?: string | null;
+}
+/** @oneof */
+interface ProductInstanceContractDetailsOneOf {
+    /** Billing information for the contract between the reseller and Wix. */
+    billingInfo?: ProductInstanceCycle;
+}
+declare enum FailureReasonFailureReason {
+    UNKNOWN = "UNKNOWN",
+    /** The delivery of the product took too long */
+    DELIVERY_TIMEOUT = "DELIVERY_TIMEOUT",
+    /** An external process failed */
+    EXTERNAL_FAILURE = "EXTERNAL_FAILURE"
+}
+declare enum IntervalIntervalUnit {
+    /** unknown interval unit */
+    UNKNOWN = "UNKNOWN",
+    /** day */
+    DAY = "DAY",
+    /** week */
+    WEEK = "WEEK",
+    /** month */
+    MONTH = "MONTH",
+    /** year */
+    YEAR = "YEAR"
+}
+declare enum CycleDescriptorType {
+    UNKNOWN = "UNKNOWN",
+    ONE_TIME = "ONE_TIME",
+    RECURRING = "RECURRING"
+}
+interface CycleInterval {
+    /** Unit of the billing cycle. */
+    unit?: IntervalIntervalUnit;
+    /** Count of units that make up the billing cycle. */
+    count?: number;
+}
+declare enum Status {
+    PENDING = "PENDING",
+    ENABLED = "ENABLED",
+    CANCELED = "CANCELED",
+    FAILED = "FAILED",
+    AWAITING_ACTION = "AWAITING_ACTION"
+}
+interface FailureReason {
+    /**
+     * Failure code.
+     *
+     * + `DELIVERY_TIMEOUT`: The product instance couldn't be created because the Resellers API timed out.
+     * + `EXTERNAL_FAILURE`: The product instance couldn't be created because an external process failed. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more information.
+     */
+    code?: FailureReasonFailureReason;
+    /** Failure message. */
+    message?: string;
+}
+interface ProductInstanceCycle {
+    /**
+     * Payment type.
+     * + `UNKNOWN`: The payment type hasn't been set.
+     * + `ONE_TIME`: The reseller pays Wix in a single payment.
+     * + `RECURRING`: The reseller pays Wix on a recurring schedule.
+     */
+    type?: CycleDescriptorType;
+    /** Duration of the billing cycle. Available only for `RECURRING` payments. */
+    cycleDuration?: CycleInterval;
+}
+interface MigrateSubscriptionToPackagesRequest {
+    /** Created package. */
+    productInstance?: ProductInstance;
+    /** Existing subscriptionId to migrate */
+    subscriptionId?: string | null;
+    /** User id of the migration - only for Immigrator */
+    userId?: string | null;
+}
+interface MigrateSubscriptionToPackagesResponse {
+    package?: Package;
+}
+interface CreatePackageRequest {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
+    externalId?: string | null;
+    /** Wix services that are resold. */
+    products: ProductInstance[];
+}
+interface CreatePackageResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Created package. */
+    package?: Package;
+}
+interface CancelPackageRequest {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** ID of the package to cancel. */
+    _id: string;
+}
+interface CancelPackageResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Canceled package. */
+    package?: Package;
+}
+interface PackageCanceled {
+    /** Canceled package. */
+    package?: Package;
+}
+interface GetPackageRequest {
+    /** Package ID. */
+    _id: string;
+}
+interface GetPackageResponse {
+    /** Retrieved package. */
+    package?: Package;
+}
+interface QueryPackagesRequest {
+    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    query: QueryV2;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface QueryPackagesResponse {
+    /** Paging metadata. */
+    metadata?: PagingMetadataV2;
+    /**
+     * Retrieved packages.
+     *
+     * Max: 1000 packages
+     */
+    packages?: Package[];
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface AssignProductInstanceToSiteRequest {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** ID of the product instance to assign to a site. */
+    instanceId: string;
+    /** ID of the site to which the product instance is assigned. */
+    siteId: string;
+}
+interface AssignProductInstanceToSiteResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the assigned product instance. */
+    package?: Package;
+}
+interface AssignedProductInstanceToSite {
+    /** Updated package. */
+    package?: Package;
+    /**
+     * ID of the product instance that was assigned to the site.
+     * @readonly
+     */
+    productInstanceId?: string;
+    /**
+     * ID of the site the product instance was assigned to.
+     * @readonly
+     */
+    siteId?: string;
+}
+interface UnassignProductInstanceFromSiteRequest {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** ID of the product instance to unassign from a site. */
+    instanceId: string;
+}
+interface UnassignProductInstanceFromSiteResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the unassigned product instance. */
+    package?: Package;
+}
+interface UnassignedProductInstanceFromSite {
+    /** Updated package. */
+    package?: Package;
+    /**
+     * ID of the product instance that was unassigned from the site.
+     * @readonly
+     */
+    productInstanceId?: string;
+    /**
+     * MetasiteId of the site the product instance was unassigned from.
+     * @readonly
+     */
+    metaSiteId?: string;
+}
+interface CancelProductInstanceRequest {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** ID of the product instance to cancel. */
+    instanceId: string;
+}
+interface CancelProductInstanceResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the previously included the canceled product instance. */
+    package?: Package;
+}
+interface ProductInstanceCanceled {
+    /** Updated package. */
+    package?: Package;
+    /**
+     * ID of the product instance that was canceled.
+     * @readonly
+     */
+    productInstanceId?: string;
+}
+interface AdjustProductInstanceSpecificationsRequest {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** ID of the product instance to adjust. */
+    instanceId: string;
+    /**
+     * ID of the product to replace the original instance. Required in case you don't
+     * provide a new `billingInfo` object.
+     */
+    catalogProductId?: string | null;
+    /**
+     * Information about the billing cycle. Required in case you don't provide a new
+     * `catalogProductId`. The new billing cycle must be supported for the service.
+     * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
+     * information about a service's supported billing cycles. If
+     * you adjust the billing cycle for a product instance with `RECURRING`
+     * payments, you must also provide `billingInfo.cycleDuration.unit`.
+     */
+    billingInfo?: ProductInstanceCycle;
+    /**
+     * Discount code indicating that the reseller provisioned the product instance
+     * during a sale. Ignored when you don't pass a new `catalogProductId` as well.
+     * In case you pass a code that isn't valid, the call succeeds and
+     * no discount is applied to the product instance. Wix doesn't guarantee that a
+     * discount code reduces the price between Wix and the reseller, even when it's
+     * valid. You can't add a discount code after you've created the
+     * product instance. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
+     * more information about supported codes.
+     *
+     * Max: 25 characters
+     */
+    discountCode?: string | null;
+}
+interface AdjustProductInstanceSpecificationsResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the adjusted product instance. */
+    package?: Package;
+}
+interface AdjustedProductInstanceSpecifications {
+    /** Updated package. */
+    package?: Package;
+    /**
+     * ID of the product instance to adjust.
+     * @readonly
+     */
+    productInstanceId?: string;
+}
+interface SubscriptionEvent extends SubscriptionEventEventOneOf {
+    /** Triggered when a subscription is created. */
+    created?: SubscriptionCreated;
+    /**
+     * Triggered when a subscription is assigned to a Wix site, including the initial
+     * assignment of a floating subscription or a re-assignement from a different site.
+     */
+    assigned?: SubscriptionAssigned;
+    /** Triggered when a subscription is canceled. */
+    cancelled?: SubscriptionCancelled;
+    /** Triggered when the subscription's auto renew is turned on. */
+    autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;
+    /** Triggered when the subscription's auto renew is turned off. */
+    autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;
+    /**
+     * Triggered when a subscription is unassigned from a Wix site and becomes
+     * floating.
+     */
+    unassigned?: SubscriptionUnassigned;
+    /**
+     * Triggered when a subscription is transferred from one Wix account to another.
+     * A transfer includes cancelling the original subscription and creating a new
+     * subscription for the target account. The event returns both the original
+     * and the new subscription.
+     */
+    transferred?: SubscriptionTransferred;
+    /** Triggered when a recurring charge succeeds for a subscription. */
+    recurringChargeSucceeded?: RecurringChargeSucceeded;
+    /**
+     * Triggered when a subscription was updated including when its product has been
+     * up- or downgraded or the billing cycle is changed.
+     */
+    contractSwitched?: ContractSwitched;
+    /**
+     * Triggered when a subscription gets close to the end of its billing cycle.
+     * The exact number of days is defined in the billing system.
+     */
+    nearEndOfPeriod?: SubscriptionNearEndOfPeriod;
+    /**
+     * Triggered when a subscription is updated and the change doesn't happen
+     * immediately but at the end of the current billing cycle.
+     */
+    pendingChange?: SubscriptionPendingChange;
+    /** ID of the subscription's event. */
+    eventId?: string | null;
+    /**
+     * Date and time of the event in
+     * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    eventDate?: Date;
+}
+/** @oneof */
+interface SubscriptionEventEventOneOf {
+    /** Triggered when a subscription is created. */
+    created?: SubscriptionCreated;
+    /**
+     * Triggered when a subscription is assigned to a Wix site, including the initial
+     * assignment of a floating subscription or a re-assignement from a different site.
+     */
+    assigned?: SubscriptionAssigned;
+    /** Triggered when a subscription is canceled. */
+    cancelled?: SubscriptionCancelled;
+    /** Triggered when the subscription's auto renew is turned on. */
+    autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;
+    /** Triggered when the subscription's auto renew is turned off. */
+    autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;
+    /**
+     * Triggered when a subscription is unassigned from a Wix site and becomes
+     * floating.
+     */
+    unassigned?: SubscriptionUnassigned;
+    /**
+     * Triggered when a subscription is transferred from one Wix account to another.
+     * A transfer includes cancelling the original subscription and creating a new
+     * subscription for the target account. The event returns both the original
+     * and the new subscription.
+     */
+    transferred?: SubscriptionTransferred;
+    /** Triggered when a recurring charge succeeds for a subscription. */
+    recurringChargeSucceeded?: RecurringChargeSucceeded;
+    /**
+     * Triggered when a subscription was updated including when its product has been
+     * up- or downgraded or the billing cycle is changed.
+     */
+    contractSwitched?: ContractSwitched;
+    /**
+     * Triggered when a subscription gets close to the end of its billing cycle.
+     * The exact number of days is defined in the billing system.
+     */
+    nearEndOfPeriod?: SubscriptionNearEndOfPeriod;
+    /**
+     * Triggered when a subscription is updated and the change doesn't happen
+     * immediately but at the end of the current billing cycle.
+     */
+    pendingChange?: SubscriptionPendingChange;
+}
+/** Triggered when a subscription is created. */
+interface SubscriptionCreated {
+    /** Created subscription. */
+    subscription?: Subscription;
+    /** Metadata for the `created` event. */
+    metadata?: Record<string, string>;
+    /**
+     * Subscription reactivation data.
+     * A subscription can be reactivated for example if it was incorrectly canceled because of fraud and then reactivated
+     * by the billing system
+     */
+    reactivationData?: ReactivationData;
+}
+/**
+ * A subscription holds information about a Premium product that a Wix account
+ * owner has purchased including details about the billing.
+ */
+interface Subscription {
+    /** ID of the subscription. */
+    _id?: string;
+    /** ID of the Wix account that purchased the subscription. */
+    userId?: string;
+    /**
+     * ID of the [product](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/products/product-object)
+     * for which the subscription was purchased.
+     */
+    productId?: string;
+    /**
+     * Date and time the subscription was created in
+     * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    createdAt?: Date;
+    /**
+     * Date and time the subscription was last updated in
+     * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    updatedAt?: Date;
+    /**
+     * ID of the metasite that the subscription is assigned to.
+     * Available only when the subscription is assigned to a Wix site.
+     * Subscriptions for account level products can't be assigned to a Wix site.
+     */
+    metaSiteId?: string | null;
+    /** Information about the system that manages the subscription's billing. */
+    billingReference?: BillingReference;
+    /** Information about the billing cycle of the subscription. */
+    cycle?: Cycle;
+    /**
+     * Subscription status.
+     *
+     * + `UNKNOWN`: Default status.
+     * + `AUTO_RENEW_ON`: Subscription is active and automatically renews at the end of the current billing cycle.
+     * + `AUTO_RENEW_OFF`: Subscription is active but expires at the end of the current billing cycle.
+     * + `MANUAL_RECURRING`: Subscription is active and renews at the end of the current billing cycle, in case the customer takes an action related to the payment.
+     * + `CANCELLED`: Subscription isn't active because it has been canceled.
+     * + `TRANSFERRED`: Subscription isn't active because it has been transferred to a different account. A different active subscription was created for the target account.
+     */
+    status?: SubscriptionStatus;
+    /**
+     * Date and time the subscription was last transferred from one Wix account to
+     * another in
+     * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     */
+    transferredAt?: Date;
+    /**
+     * ID of the [product type](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/product-types/product-type-object)
+     * that the product, for which the subscription was purchased, belongs to.
+     */
+    productTypeId?: string;
+    /** Version number, which increments by 1 each time the subscription is updated. */
+    version?: number;
+    /**
+     * Whether the subscription is active. Includes the statuses
+     * `"AUTO_RENEW_ON"`, `"AUTO_RENEW_OFF"`, and `"MANUAL_RECURRING"`.
+     */
+    active?: boolean;
+    /**
+     * Date and time the subscription was originally created in
+     * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * Differs from `createdAt` in case the subscription was originally created for a different Wix account and has been transferred.
+     */
+    originalCreationDate?: Date;
+    /** Custom metadata about the subscription. */
+    metadata?: Record<string, string>;
+    /**
+     * 2-letter country code in
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+     * format.
+     */
+    countryCode?: string | null;
+}
+interface BillingReference {
+    /**
+     * Name of the billing system that manages the subscription.
+     *
+     * + `"UNKNOWN"`: Default value.
+     * + `"SBS"`: [Wix Billing](https://github.com/wix-p/premium-billing/tree/master/sbs).
+     * + `"LICENSER"`:
+     * + `"BASS"`: [Billing and Subscriptions System](https://dev.wix.com/docs/rest/internal-only/premium/subscriptions-by-billing-by-wix/introduction).
+     * + `"RESELLER"`: [External Reseller](https://dev.wix.com/api/rest/account-level-apis/resellers/introduction).
+     */
+    providerName?: ProviderName;
+    /** Current provider reference ID. */
+    providerReferenceId?: string | null;
+    /** Previous provider reference IDs. Used for when a subscription is extended, specifically for domains. */
+    previousProviderReferenceIds?: string[];
+}
+declare enum ProviderName {
+    UNKNOWN = "UNKNOWN",
+    SBS = "SBS",
+    LICENSER = "LICENSER",
+    BASS = "BASS",
+    RESELLER = "RESELLER",
+    RECURRING_INVOICES = "RECURRING_INVOICES"
+}
+interface Cycle extends CycleCycleSelectorOneOf {
+    /** repetitive interval */
+    interval?: Interval;
+    /** one time */
+    oneTime?: OneTime;
+}
+/** @oneof */
+interface CycleCycleSelectorOneOf {
+    /** repetitive interval */
+    interval?: Interval;
+    /** one time */
+    oneTime?: OneTime;
+}
+interface Interval {
+    /** interval unit of measure */
+    unit?: IntervalUnit;
+    /** number of interval */
+    count?: number;
+}
+declare enum IntervalUnit {
+    /** unknown interval unit */
+    UNKNOWN = "UNKNOWN",
+    /** day */
+    DAY = "DAY",
+    /** week */
+    WEEK = "WEEK",
+    /** month */
+    MONTH = "MONTH",
+    /** year */
+    YEAR = "YEAR"
+}
+interface OneTime {
+}
+declare enum SubscriptionStatus {
+    UNKNOWN = "UNKNOWN",
+    AUTO_RENEW_ON = "AUTO_RENEW_ON",
+    AUTO_RENEW_OFF = "AUTO_RENEW_OFF",
+    MANUAL_RECURRING = "MANUAL_RECURRING",
+    CANCELLED = "CANCELLED",
+    TRANSFERRED = "TRANSFERRED"
+}
+/** Triggered when a subscription is reactivated. */
+interface ReactivationData {
+    reactivationReason?: ReactivationReasonEnum;
+    /**
+     * In the event of reactivation after chargeback dispute, the subscription may be extended according to the
+     * number of days it was inactive during the time of resolving the dispute
+     */
+    newEndOfPeriod?: Date;
+    /** The original end date, before the inactive period. */
+    oldEndOfPeriod?: Date;
+    /** The difference in days between the new new_end_of_period and old_end_of_period */
+    differenceInDays?: number | null;
+}
+/** Reason for subscription reactivation */
+declare enum ReactivationReasonEnum {
+    UNKNOWN = "UNKNOWN",
+    /**
+     * Subscription was reactivated due to billing status change from CANCELED to ACTIVE, for example if it was incorrectly
+     * canceled because of suspicion of fraud
+     */
+    BILLING_STATUS_CHANGE = "BILLING_STATUS_CHANGE",
+    /** Subscription was reactivated after a chargeback dispute */
+    REACTIVATED_AFTER_CHARGEBACK = "REACTIVATED_AFTER_CHARGEBACK"
+}
+/**
+ * Triggered when a subscription is assigned to a Wix site, including the initial
+ * assignment of a floating subscription or a re-assignement from a different site.
+ */
+interface SubscriptionAssigned {
+    /** Assigned subscription. */
+    subscription?: Subscription;
+    /** ID of the metasite that the subscription has been assigned to before the update. */
+    previousMetaSiteId?: string | null;
+}
+/** Triggered when a subscription is canceled. */
+interface SubscriptionCancelled {
+    /** Canceled subscription. */
+    subscription?: Subscription;
+    /** Details about the cancellation including who canceled the subscription and why. */
+    cancellationDetails?: CancellationDetails;
+    /**
+     * Whether the subscription is canceled immediately or expires at the end of the current billing cycle.
+     *
+     * Default: `false`
+     */
+    immediateCancel?: boolean;
+    /** Whether the subscription was canceled during the free trial period. */
+    canceledInFreeTrial?: boolean;
+}
+/** Information about the cancellation flow including who canceled the subscription and why it was canceled. */
+interface CancellationDetails {
+    /**
+     * Cancellation code.
+     *
+     * Values supported for cancellations on behalf of the billing system: `-1`, `-2`, `-3`, `-4`, `-5`, `-6`, `-7`, `-8`.
+     * For cancellations on behalf of the site owner or the service provider `cancellationCode`
+     * is taken from the request of
+     * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
+     *
+     * + `-1`: The subscription has been cancelled by the billing system but none of the listed cancellation reasons applies.
+     * + `-2`: There were payment problems.
+     * + `-3`: There was a chargeback.
+     * + `-4`: Customer support has canceled the subscription and issued a refund.
+     * + `-5`: The site owner has changed their existing subscription.
+     * + `-6`: The subscription has been transferred to a different Wix account.
+     * + `-7`: The subscription has been canceled because the site owner hasn't manually authenticated the recurring payment during the subscription's grace period. For example, site owners must manually confirm recurring payments within 40 days when paying with boleto.
+     * + `-8`: The Wix account that the subscription belonged to has been deleted.
+     */
+    cancellationCode?: number | null;
+    /**
+     * Cancellation reason. For cancellations on behalf of the site owner or the service provider `cancellationReason`
+     * is taken from the request of
+     * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
+     * For cancellations on behalf of the billing system `cancellationReason` is `null` or an empty string.
+     */
+    cancellationReason?: string | null;
+    /**
+     * Initiator of the cancellation. For `"USER_REQUESTED"` and `"APP_MANAGED"`,
+     * `cancellationCode` and `cancellationReason` are taken from the request of
+     * [Cancel Immediately](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately)
+     * or [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
+     * For `"PASSIVE"`, cancellations `cancellationCode` is automatically calculated and `cancellationReason`
+     * is `null` or an empty string.
+     *
+     * + `"UNKNOWN`: Default value.
+     * + `"USER_REQUESTED"`:  The Wix account owner has canceled the subscription.
+     * + `"APP_MANAGED"`: The service provider has canceled the subscription.
+     * + `"PASSIVE"`: The billing system has canceled the subscription. For example, in case of payment failure or fraud.
+     */
+    initiator?: Initiator;
+}
+declare enum Initiator {
+    UNKNOWN = "UNKNOWN",
+    USER_REQUESTED = "USER_REQUESTED",
+    APP_MANAGED = "APP_MANAGED",
+    PASSIVE = "PASSIVE"
+}
+/** Triggered when the subscription's auto renew is turned on. */
+interface SubscriptionAutoRenewTurnedOn {
+    /** Subscription for which auto renew is turned on. */
+    subscription?: Subscription;
+    /**
+     * Supported values: `USER`, `APP`.
+     *
+     * Information about who turned auto renew on.
+     * + `"USER"`: The site owner who purchased the subscription has turned auto renew on.
+     * + `"APP"`: The service provider has turned auto renew on.
+     */
+    initiator?: string | null;
+}
+/** Triggered when the subscription's auto renew is turned off. */
+interface SubscriptionAutoRenewTurnedOff {
+    /** Subscription for which auto renew is turned off. */
+    subscription?: Subscription;
+    /** Details about the cancellation including who canceled the subscription and why. */
+    cancellationDetails?: CancellationDetails;
+    /**
+     * Whether the subscription is immediately canceled or expires at the end of the current billing cycle.
+     *
+     * Default: `false`
+     */
+    immediateCancel?: boolean;
+}
+/**
+ * Triggered when a subscription is unassigned from a Wix site and becomes
+ * floating.
+ */
+interface SubscriptionUnassigned {
+    /** Unassigned subscription. */
+    subscription?: Subscription;
+    /** ID of the metasite that the subscription has been assigned to before the event. */
+    previousMetaSiteId?: string;
+    /**
+     * Reason why the subscription is unassigned.
+     *
+     * + `"UNKNOWN"`: Default value.
+     * + `"USER_REQUESTED"`: The Wix account owner has unassigned the subscription.
+     * + `"REPLACED_BY_ANOTHER_SUBSCRIPTION"`: A different subscription that replaces this subscription is assigned to the site.
+     */
+    unassignReason?: UnassignReason;
+}
+declare enum UnassignReason {
+    UNKNOWN = "UNKNOWN",
+    USER_REQUESTED = "USER_REQUESTED",
+    REPLACED_BY_ANOTHER_SUBSCRIPTION = "REPLACED_BY_ANOTHER_SUBSCRIPTION"
+}
+/**
+ * Triggered when a subscription is transferred from one Wix account to another.
+ * A transfer includes cancelling the original subscription and creating a new
+ * subscription for the target account. The event returns both the original
+ * and the new subscription.
+ */
+interface SubscriptionTransferred {
+    /** Original subscription that was canceled for the transfer. */
+    originSubscription?: Subscription;
+    /** Newly created subscription for the target account. */
+    targetSubscription?: Subscription;
+}
+/** Triggered when a recurring charge succeeds for a subscription. */
+interface RecurringChargeSucceeded {
+    /** Subscription for which the recurring charge has succeeded. */
+    subscription?: Subscription;
+    /** Indication that there was a successful charge at the end of the free trial period */
+    freeTrialPeriodEnd?: boolean;
+}
+/**
+ * Triggered when a subscription was updated including when its product has been
+ * up- or downgraded or the billing cycle is changed.
+ */
+interface ContractSwitched {
+    /** Updated subscription. */
+    subscription?: Subscription;
+    /** Billing cycle before the update. */
+    previousCycle?: Cycle;
+    /** ID of the product belonging to the subscription before the update. */
+    previousProductId?: string;
+    /** ID of the product type that the subscription's original product belonged to before the update. */
+    previousProductTypeId?: string;
+    /**
+     * Update type. __Note__: Doesn't include information about a product adjustment.
+     * For that purpose, see `productAdjustment`.
+     *
+     * + `"NOT_APPLICABLE"`: Default value.
+     * + `"ADDITIONAL_QUANTITY"`: An increased usage quota is added to the subscription. For example, a second mailbox is added to a subscription that previously included a single mailbox.
+     * + `"CREDIT_UNUSED_PERIOD"`: The subscription is upgraded and the new price is less than the regular price. The new price applies to every billing cycle, not just the first cycle.
+     * + `"REFUND_PRICE_DIFF"`: Not implemented.
+     * + `"ADJUST_PERIOD_END"`: Not implemented.
+     * + `"DOWNGRADE_GRACE_PERIOD"`: For downgrades during the grace period. In this situation, the site owner hasn’t paid yet and must immediately pay for the downgraded subscription.
+     * + `"FULL_AMOUNT_PERIOD"`: For upgrades in which the site owner retains unused benefits. For example, site owners upgrading a Facebook Ads subscription retain their unused FB Ads credit. The unused credit is added to the new credit.
+     * + `"END_OF_PERIOD"`: The subscription's billing current cycle is extended because of a downgrade.
+     * + `"PENDING_CHANGES"`: The subscription's billing is updated, but the change doesn't apply immediately. Instead, the update becomes effective at the end of current billing cycle.
+     * + `"DOWNGRADE_RENEWAL"`: The subscription is downgraded because of a declined payment. This prevents subscriptions from churning.
+     */
+    contractSwitchType?: ContractSwitchType;
+    /**
+     * ID of the metasite the subscription has been assigned to previously.
+     * Available only in case the subscription is assigned to a different site.
+     */
+    previousMetaSiteId?: string | null;
+    /**
+     * Update reason.
+     *
+     * + `"PRICE_INCREASE"`: The subscription's price has been increased.
+     * + `"EXTERNAL_PROVIDER_TRIGGER"`: Any reason other than a price increase.
+     */
+    contractSwitchReason?: ContractSwitchReason;
+    /** Information about the price update. Available only for updates with a price increase. */
+    productPriceIncreaseData?: ProductPriceIncreaseData;
+    /**
+     * Information about a product adjustment. For example, a downgrade.
+     * __Note__: This isn't the same as `contractSwitchType`.
+     *
+     * + `NOT_APPLICABLE`: There is no information about whether the product has been up- or downgraded.
+     * + `DOWNGRADE`: The product has been downgraded.
+     */
+    productAdjustment?: ProductAdjustment;
+}
+/** Copied from SBS */
+declare enum ContractSwitchType {
+    NOT_APPLICABLE = "NOT_APPLICABLE",
+    ADDITIONAL_QUANTITY = "ADDITIONAL_QUANTITY",
+    CREDIT_UNUSED_PERIOD = "CREDIT_UNUSED_PERIOD",
+    REFUND_PRICE_DIFF = "REFUND_PRICE_DIFF",
+    ADJUST_PERIOD_END = "ADJUST_PERIOD_END",
+    DOWNGRADE_GRACE_PERIOD = "DOWNGRADE_GRACE_PERIOD",
+    FULL_AMOUNT_PERIOD = "FULL_AMOUNT_PERIOD",
+    END_OF_PERIOD = "END_OF_PERIOD",
+    PENDING_CHANGES = "PENDING_CHANGES",
+    DOWNGRADE_RENEWAL = "DOWNGRADE_RENEWAL"
+}
+declare enum ContractSwitchReason {
+    EXTERNAL_PROVIDER_TRIGGER = "EXTERNAL_PROVIDER_TRIGGER",
+    PRICE_INCREASE = "PRICE_INCREASE"
+}
+/** Triggered when a subscription's price is increased. */
+interface ProductPriceIncreaseData {
+    /** Price of the subscription before the update. */
+    previousPrice?: string | null;
+    /** A value that is used in order to select the correct email template to send the user regarding the price increase. */
+    emailTemplateSelector?: string | null;
+    /** Used to differentiate between migration segments. Does not have to be unique per segment. */
+    segmentName?: string | null;
+    /** Used to determine how the price increase was triggered. */
+    priceIncreaseTrigger?: PriceIncreaseTrigger;
+}
+/** Reason for Price Increase Trigger */
+declare enum PriceIncreaseTrigger {
+    NEAR_RENEWAL = "NEAR_RENEWAL",
+    RECURRING_SUCCESS = "RECURRING_SUCCESS",
+    MANUAL = "MANUAL"
+}
+/** Triggered when a subscription's product is adusted. */
+declare enum ProductAdjustment {
+    /** flag to show that the ContractSwitchedEvent is not applicable / needed */
+    NOT_APPLICABLE = "NOT_APPLICABLE",
+    /** flag to show that the ContractSwitchedEvent is a Downgrade */
+    DOWNGRADE = "DOWNGRADE"
+}
+/**
+ * Triggered when a subscription gets close to the end of its billing cycle.
+ * The exact number of days is defined in the billing system.
+ */
+interface SubscriptionNearEndOfPeriod {
+    /** Subscription that got close to the end of its billing cycle. */
+    subscription?: Subscription;
+    /** Whether the subscription is within the free trial period. */
+    inFreeTrial?: boolean;
+}
+/**
+ * Triggered when a subscription is updated and the change doesn't happen
+ * immediately but at the end of the current billing cycle.
+ */
+interface SubscriptionPendingChange {
+    /** Subscription for which a pending update is triggered. */
+    subscription?: Subscription;
+}
+interface Empty {
+}
+interface ProductInstanceUpdated {
+    /** Updated package. */
+    package?: Package;
+    /**
+     * ID of the product instance that was adjusted.
+     * @readonly
+     */
+    productInstanceId?: string;
+}
+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;
+    /**
+     * 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 */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date;
+}
+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;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface FailureReportRequest {
+    /** ID of the product instance that failed. */
+    instanceId?: string;
+    /** Failure reason. */
+    reason?: FailureReason;
+}
+interface ProductInstanceFailed {
+    /** Updated package. */
+    package?: Package;
+    /**
+     * ID of the product instance that `FAILED`.
+     * @readonly
+     */
+    productInstanceId?: string;
+    /** Failure reason. */
+    reason?: FailureReason;
+}
+interface Task {
+    key?: TaskKey;
+    executeAt?: Date;
+    payload?: string | null;
+}
+interface TaskKey {
+    appId?: string;
+    instanceId?: string;
+    subjectId?: string | null;
+}
+interface TaskAction extends TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+/** @oneof */
+interface TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+interface Complete {
+}
+interface Cancel {
+}
+interface Reschedule {
+    executeAt?: Date;
+    payload?: string | null;
+}
+interface UpdateProductInstanceRequest {
+    /** ID of the product instance to update. */
+    instanceId?: string;
+    status?: Status;
+    countryCode?: string | null;
+    /** Which field to update, currently only status and countryCode are supported. */
+    fieldToUpdate?: FieldToUpdate;
+}
+declare enum FieldToUpdate {
+    STATUS = "STATUS",
+    COUNTRY_CODE = "COUNTRY_CODE"
+}
+interface UpdateProductInstanceResponse {
+    /** Updated Product Instance */
+    productInstance?: ProductInstance;
+}
+interface UpdatePackageExternalIdRequest {
+    /** The id of the package that we want to update. */
+    packageId: string;
+    /** The external id that will be assigned to the package. */
+    externalId: string;
+}
+interface UpdatePackageExternalIdResponse {
+    /** Updated Package */
+    updatedPackage?: Package;
+}
+interface CountPackagesRequest {
+    /** Filter on what packages to count */
+    filter?: Record<string, any> | null;
+}
+interface CountPackagesResponse {
+    /** Number of packages */
+    count?: number;
+}
+interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface CycleIntervalNonNullableFields {
+    unit: IntervalIntervalUnit;
+    count: number;
+}
+interface ProductInstanceCycleNonNullableFields {
+    type: CycleDescriptorType;
+    cycleDuration?: CycleIntervalNonNullableFields;
+}
+interface FailureReasonNonNullableFields {
+    code: FailureReasonFailureReason;
+    message: string;
+}
+interface ProductInstanceNonNullableFields {
+    billingInfo?: ProductInstanceCycleNonNullableFields;
+    instanceId: string;
+    catalogProductId: string;
+    status: Status;
+    failure?: FailureReasonNonNullableFields;
+}
+interface PackageNonNullableFields {
+    _id: string;
+    accountId: string;
+    productInstances: ProductInstanceNonNullableFields[];
+}
+interface CreatePackageResponseNonNullableFields {
+    package?: PackageNonNullableFields;
+}
+interface CancelPackageResponseNonNullableFields {
+    package?: PackageNonNullableFields;
+}
+interface GetPackageResponseNonNullableFields {
+    package?: PackageNonNullableFields;
+}
+interface QueryPackagesResponseNonNullableFields {
+    packages: PackageNonNullableFields[];
+}
+interface AssignProductInstanceToSiteResponseNonNullableFields {
+    package?: PackageNonNullableFields;
+}
+interface UnassignProductInstanceFromSiteResponseNonNullableFields {
+    package?: PackageNonNullableFields;
+}
+interface CancelProductInstanceResponseNonNullableFields {
+    package?: PackageNonNullableFields;
+}
+interface AdjustProductInstanceSpecificationsResponseNonNullableFields {
+    package?: PackageNonNullableFields;
+}
+interface UpdatePackageExternalIdResponseNonNullableFields {
+    updatedPackage?: PackageNonNullableFields;
+}
+interface CreatePackageOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
+    externalId?: string | null;
+    /** Wix services that are resold. */
+    products: ProductInstance[];
+}
+interface CreatePackageV2Options {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
+    externalId?: string | null;
+    /** Wix services that are resold. */
+    products: ProductInstance[];
+}
+interface CancelPackageOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+}
+interface AssignProductInstanceToSiteIdentifiers {
+    /** ID of the product instance to assign to a site. */
+    instanceId: string;
+    /** ID of the site to which the product instance is assigned. */
+    siteId: string;
+}
+interface AssignProductInstanceToSiteOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+}
+interface UnassignProductInstanceFromSiteOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+}
+interface CancelProductInstanceOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+}
+interface AdjustProductInstanceSpecificationsOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /**
+     * ID of the product to replace the original instance. Required in case you don't
+     * provide a new `billingInfo` object.
+     */
+    catalogProductId?: string | null;
+    /**
+     * Information about the billing cycle. Required in case you don't provide a new
+     * `catalogProductId`. The new billing cycle must be supported for the service.
+     * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
+     * information about a service's supported billing cycles. If
+     * you adjust the billing cycle for a product instance with `RECURRING`
+     * payments, you must also provide `billingInfo.cycleDuration.unit`.
+     */
+    billingInfo?: ProductInstanceCycle;
+    /**
+     * Discount code indicating that the reseller provisioned the product instance
+     * during a sale. Ignored when you don't pass a new `catalogProductId` as well.
+     * In case you pass a code that isn't valid, the call succeeds and
+     * no discount is applied to the product instance. Wix doesn't guarantee that a
+     * discount code reduces the price between Wix and the reseller, even when it's
+     * valid. You can't add a discount code after you've created the
+     * product instance. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
+     * more information about supported codes.
+     *
+     * Max: 25 characters
+     */
+    discountCode?: string | null;
+}
+interface UpdatePackageExternalIdOptions {
+    /** The external id that will be assigned to the package. */
+    externalId: string;
+}
+
 type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
 interface HttpClient {
     request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
@@ -43,8 +1362,145 @@ declare const assignProductInstanceToSite: ReturnType<typeof createRESTModule<ty
 declare const unassignProductInstanceFromSite: ReturnType<typeof createRESTModule<typeof publicUnassignProductInstanceFromSite>>;
 declare const cancelProductInstance: ReturnType<typeof createRESTModule<typeof publicCancelProductInstance>>;
 declare const adjustProductInstanceSpecifications: ReturnType<typeof createRESTModule<typeof publicAdjustProductInstanceSpecifications>>;
-declare const updatePackage: ReturnType<typeof createRESTModule<typeof publicUpdatePackage>>;
+declare const updatePackageExternalId: ReturnType<typeof createRESTModule<typeof publicUpdatePackageExternalId>>;
 
+type context_ActionEvent = ActionEvent;
+type context_AdjustProductInstanceSpecificationsOptions = AdjustProductInstanceSpecificationsOptions;
+type context_AdjustProductInstanceSpecificationsRequest = AdjustProductInstanceSpecificationsRequest;
+type context_AdjustProductInstanceSpecificationsResponse = AdjustProductInstanceSpecificationsResponse;
+type context_AdjustProductInstanceSpecificationsResponseNonNullableFields = AdjustProductInstanceSpecificationsResponseNonNullableFields;
+type context_AdjustedProductInstanceSpecifications = AdjustedProductInstanceSpecifications;
+type context_AssignProductInstanceToSiteIdentifiers = AssignProductInstanceToSiteIdentifiers;
+type context_AssignProductInstanceToSiteOptions = AssignProductInstanceToSiteOptions;
+type context_AssignProductInstanceToSiteRequest = AssignProductInstanceToSiteRequest;
+type context_AssignProductInstanceToSiteResponse = AssignProductInstanceToSiteResponse;
+type context_AssignProductInstanceToSiteResponseNonNullableFields = AssignProductInstanceToSiteResponseNonNullableFields;
+type context_AssignedProductInstanceToSite = AssignedProductInstanceToSite;
+type context_BillingReference = BillingReference;
+type context_Cancel = Cancel;
+type context_CancelPackageOptions = CancelPackageOptions;
+type context_CancelPackageRequest = CancelPackageRequest;
+type context_CancelPackageResponse = CancelPackageResponse;
+type context_CancelPackageResponseNonNullableFields = CancelPackageResponseNonNullableFields;
+type context_CancelProductInstanceOptions = CancelProductInstanceOptions;
+type context_CancelProductInstanceRequest = CancelProductInstanceRequest;
+type context_CancelProductInstanceResponse = CancelProductInstanceResponse;
+type context_CancelProductInstanceResponseNonNullableFields = CancelProductInstanceResponseNonNullableFields;
+type context_CancellationDetails = CancellationDetails;
+type context_Complete = Complete;
+type context_ContractSwitchReason = ContractSwitchReason;
+declare const context_ContractSwitchReason: typeof ContractSwitchReason;
+type context_ContractSwitchType = ContractSwitchType;
+declare const context_ContractSwitchType: typeof ContractSwitchType;
+type context_ContractSwitched = ContractSwitched;
+type context_CountPackagesRequest = CountPackagesRequest;
+type context_CountPackagesResponse = CountPackagesResponse;
+type context_CreatePackageOptions = CreatePackageOptions;
+type context_CreatePackageRequest = CreatePackageRequest;
+type context_CreatePackageResponse = CreatePackageResponse;
+type context_CreatePackageResponseNonNullableFields = CreatePackageResponseNonNullableFields;
+type context_CreatePackageV2Options = CreatePackageV2Options;
+type context_CursorPaging = CursorPaging;
+type context_Cursors = Cursors;
+type context_Cycle = Cycle;
+type context_CycleCycleSelectorOneOf = CycleCycleSelectorOneOf;
+type context_CycleDescriptorType = CycleDescriptorType;
+declare const context_CycleDescriptorType: typeof CycleDescriptorType;
+type context_CycleInterval = CycleInterval;
+type context_DomainEvent = DomainEvent;
+type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type context_Empty = Empty;
+type context_EntityCreatedEvent = EntityCreatedEvent;
+type context_EntityDeletedEvent = EntityDeletedEvent;
+type context_EntityUpdatedEvent = EntityUpdatedEvent;
+type context_FailureReason = FailureReason;
+type context_FailureReasonFailureReason = FailureReasonFailureReason;
+declare const context_FailureReasonFailureReason: typeof FailureReasonFailureReason;
+type context_FailureReportRequest = FailureReportRequest;
+type context_FieldToUpdate = FieldToUpdate;
+declare const context_FieldToUpdate: typeof FieldToUpdate;
+type context_GetPackageRequest = GetPackageRequest;
+type context_GetPackageResponse = GetPackageResponse;
+type context_GetPackageResponseNonNullableFields = GetPackageResponseNonNullableFields;
+type context_IdentificationData = IdentificationData;
+type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type context_Initiator = Initiator;
+declare const context_Initiator: typeof Initiator;
+type context_Interval = Interval;
+type context_IntervalIntervalUnit = IntervalIntervalUnit;
+declare const context_IntervalIntervalUnit: typeof IntervalIntervalUnit;
+type context_IntervalUnit = IntervalUnit;
+declare const context_IntervalUnit: typeof IntervalUnit;
+type context_MessageEnvelope = MessageEnvelope;
+type context_MigrateSubscriptionToPackagesRequest = MigrateSubscriptionToPackagesRequest;
+type context_MigrateSubscriptionToPackagesResponse = MigrateSubscriptionToPackagesResponse;
+type context_OneTime = OneTime;
+type context_Package = Package;
+type context_PackageCanceled = PackageCanceled;
+type context_Paging = Paging;
+type context_PagingMetadataV2 = PagingMetadataV2;
+type context_PriceIncreaseTrigger = PriceIncreaseTrigger;
+declare const context_PriceIncreaseTrigger: typeof PriceIncreaseTrigger;
+type context_ProductAdjustment = ProductAdjustment;
+declare const context_ProductAdjustment: typeof ProductAdjustment;
+type context_ProductInstance = ProductInstance;
+type context_ProductInstanceCanceled = ProductInstanceCanceled;
+type context_ProductInstanceContractDetailsOneOf = ProductInstanceContractDetailsOneOf;
+type context_ProductInstanceCycle = ProductInstanceCycle;
+type context_ProductInstanceFailed = ProductInstanceFailed;
+type context_ProductInstanceUpdated = ProductInstanceUpdated;
+type context_ProductPriceIncreaseData = ProductPriceIncreaseData;
+type context_ProviderName = ProviderName;
+declare const context_ProviderName: typeof ProviderName;
+type context_QueryPackagesRequest = QueryPackagesRequest;
+type context_QueryPackagesResponse = QueryPackagesResponse;
+type context_QueryPackagesResponseNonNullableFields = QueryPackagesResponseNonNullableFields;
+type context_QueryV2 = QueryV2;
+type context_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;
+type context_ReactivationData = ReactivationData;
+type context_ReactivationReasonEnum = ReactivationReasonEnum;
+declare const context_ReactivationReasonEnum: typeof ReactivationReasonEnum;
+type context_RecurringChargeSucceeded = RecurringChargeSucceeded;
+type context_Reschedule = Reschedule;
+type context_RestoreInfo = RestoreInfo;
+type context_SortOrder = SortOrder;
+declare const context_SortOrder: typeof SortOrder;
+type context_Sorting = Sorting;
+type context_Status = Status;
+declare const context_Status: typeof Status;
+type context_Subscription = Subscription;
+type context_SubscriptionAssigned = SubscriptionAssigned;
+type context_SubscriptionAutoRenewTurnedOff = SubscriptionAutoRenewTurnedOff;
+type context_SubscriptionAutoRenewTurnedOn = SubscriptionAutoRenewTurnedOn;
+type context_SubscriptionCancelled = SubscriptionCancelled;
+type context_SubscriptionCreated = SubscriptionCreated;
+type context_SubscriptionEvent = SubscriptionEvent;
+type context_SubscriptionEventEventOneOf = SubscriptionEventEventOneOf;
+type context_SubscriptionNearEndOfPeriod = SubscriptionNearEndOfPeriod;
+type context_SubscriptionPendingChange = SubscriptionPendingChange;
+type context_SubscriptionStatus = SubscriptionStatus;
+declare const context_SubscriptionStatus: typeof SubscriptionStatus;
+type context_SubscriptionTransferred = SubscriptionTransferred;
+type context_SubscriptionUnassigned = SubscriptionUnassigned;
+type context_Task = Task;
+type context_TaskAction = TaskAction;
+type context_TaskActionActionOneOf = TaskActionActionOneOf;
+type context_TaskKey = TaskKey;
+type context_UnassignProductInstanceFromSiteOptions = UnassignProductInstanceFromSiteOptions;
+type context_UnassignProductInstanceFromSiteRequest = UnassignProductInstanceFromSiteRequest;
+type context_UnassignProductInstanceFromSiteResponse = UnassignProductInstanceFromSiteResponse;
+type context_UnassignProductInstanceFromSiteResponseNonNullableFields = UnassignProductInstanceFromSiteResponseNonNullableFields;
+type context_UnassignReason = UnassignReason;
+declare const context_UnassignReason: typeof UnassignReason;
+type context_UnassignedProductInstanceFromSite = UnassignedProductInstanceFromSite;
+type context_UpdatePackageExternalIdOptions = UpdatePackageExternalIdOptions;
+type context_UpdatePackageExternalIdRequest = UpdatePackageExternalIdRequest;
+type context_UpdatePackageExternalIdResponse = UpdatePackageExternalIdResponse;
+type context_UpdatePackageExternalIdResponseNonNullableFields = UpdatePackageExternalIdResponseNonNullableFields;
+type context_UpdateProductInstanceRequest = UpdateProductInstanceRequest;
+type context_UpdateProductInstanceResponse = UpdateProductInstanceResponse;
+type context_WebhookIdentityType = WebhookIdentityType;
+declare const context_WebhookIdentityType: typeof WebhookIdentityType;
 declare const context_adjustProductInstanceSpecifications: typeof adjustProductInstanceSpecifications;
 declare const context_assignProductInstanceToSite: typeof assignProductInstanceToSite;
 declare const context_cancelPackage: typeof cancelPackage;
@@ -54,9 +1510,9 @@ declare const context_createPackageV2: typeof createPackageV2;
 declare const context_getPackage: typeof getPackage;
 declare const context_queryPackages: typeof queryPackages;
 declare const context_unassignProductInstanceFromSite: typeof unassignProductInstanceFromSite;
-declare const context_updatePackage: typeof updatePackage;
+declare const context_updatePackageExternalId: typeof updatePackageExternalId;
 declare namespace context {
-  export { context_adjustProductInstanceSpecifications as adjustProductInstanceSpecifications, context_assignProductInstanceToSite as assignProductInstanceToSite, context_cancelPackage as cancelPackage, context_cancelProductInstance as cancelProductInstance, context_createPackage as createPackage, context_createPackageV2 as createPackageV2, context_getPackage as getPackage, context_queryPackages as queryPackages, context_unassignProductInstanceFromSite as unassignProductInstanceFromSite, context_updatePackage as updatePackage };
+  export { type context_ActionEvent as ActionEvent, type context_AdjustProductInstanceSpecificationsOptions as AdjustProductInstanceSpecificationsOptions, type context_AdjustProductInstanceSpecificationsRequest as AdjustProductInstanceSpecificationsRequest, type context_AdjustProductInstanceSpecificationsResponse as AdjustProductInstanceSpecificationsResponse, type context_AdjustProductInstanceSpecificationsResponseNonNullableFields as AdjustProductInstanceSpecificationsResponseNonNullableFields, type context_AdjustedProductInstanceSpecifications as AdjustedProductInstanceSpecifications, type context_AssignProductInstanceToSiteIdentifiers as AssignProductInstanceToSiteIdentifiers, type context_AssignProductInstanceToSiteOptions as AssignProductInstanceToSiteOptions, type context_AssignProductInstanceToSiteRequest as AssignProductInstanceToSiteRequest, type context_AssignProductInstanceToSiteResponse as AssignProductInstanceToSiteResponse, type context_AssignProductInstanceToSiteResponseNonNullableFields as AssignProductInstanceToSiteResponseNonNullableFields, type context_AssignedProductInstanceToSite as AssignedProductInstanceToSite, type context_BillingReference as BillingReference, type context_Cancel as Cancel, type context_CancelPackageOptions as CancelPackageOptions, type context_CancelPackageRequest as CancelPackageRequest, type context_CancelPackageResponse as CancelPackageResponse, type context_CancelPackageResponseNonNullableFields as CancelPackageResponseNonNullableFields, type context_CancelProductInstanceOptions as CancelProductInstanceOptions, type context_CancelProductInstanceRequest as CancelProductInstanceRequest, type context_CancelProductInstanceResponse as CancelProductInstanceResponse, type context_CancelProductInstanceResponseNonNullableFields as CancelProductInstanceResponseNonNullableFields, type context_CancellationDetails as CancellationDetails, type context_Complete as Complete, context_ContractSwitchReason as ContractSwitchReason, context_ContractSwitchType as ContractSwitchType, type context_ContractSwitched as ContractSwitched, type context_CountPackagesRequest as CountPackagesRequest, type context_CountPackagesResponse as CountPackagesResponse, type context_CreatePackageOptions as CreatePackageOptions, type context_CreatePackageRequest as CreatePackageRequest, type context_CreatePackageResponse as CreatePackageResponse, type context_CreatePackageResponseNonNullableFields as CreatePackageResponseNonNullableFields, type context_CreatePackageV2Options as CreatePackageV2Options, type context_CursorPaging as CursorPaging, type context_Cursors as Cursors, type context_Cycle as Cycle, type context_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf, context_CycleDescriptorType as CycleDescriptorType, type context_CycleInterval as CycleInterval, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_FailureReason as FailureReason, context_FailureReasonFailureReason as FailureReasonFailureReason, type context_FailureReportRequest as FailureReportRequest, context_FieldToUpdate as FieldToUpdate, type context_GetPackageRequest as GetPackageRequest, type context_GetPackageResponse as GetPackageResponse, type context_GetPackageResponseNonNullableFields as GetPackageResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_Initiator as Initiator, type context_Interval as Interval, context_IntervalIntervalUnit as IntervalIntervalUnit, context_IntervalUnit as IntervalUnit, type context_MessageEnvelope as MessageEnvelope, type context_MigrateSubscriptionToPackagesRequest as MigrateSubscriptionToPackagesRequest, type context_MigrateSubscriptionToPackagesResponse as MigrateSubscriptionToPackagesResponse, type context_OneTime as OneTime, type context_Package as Package, type context_PackageCanceled as PackageCanceled, type context_Paging as Paging, type context_PagingMetadataV2 as PagingMetadataV2, context_PriceIncreaseTrigger as PriceIncreaseTrigger, context_ProductAdjustment as ProductAdjustment, type context_ProductInstance as ProductInstance, type context_ProductInstanceCanceled as ProductInstanceCanceled, type context_ProductInstanceContractDetailsOneOf as ProductInstanceContractDetailsOneOf, type context_ProductInstanceCycle as ProductInstanceCycle, type context_ProductInstanceFailed as ProductInstanceFailed, type context_ProductInstanceUpdated as ProductInstanceUpdated, type context_ProductPriceIncreaseData as ProductPriceIncreaseData, context_ProviderName as ProviderName, type context_QueryPackagesRequest as QueryPackagesRequest, type context_QueryPackagesResponse as QueryPackagesResponse, type context_QueryPackagesResponseNonNullableFields as QueryPackagesResponseNonNullableFields, type context_QueryV2 as QueryV2, type context_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type context_ReactivationData as ReactivationData, context_ReactivationReasonEnum as ReactivationReasonEnum, type context_RecurringChargeSucceeded as RecurringChargeSucceeded, type context_Reschedule as Reschedule, type context_RestoreInfo as RestoreInfo, context_SortOrder as SortOrder, type context_Sorting as Sorting, context_Status as Status, type context_Subscription as Subscription, type context_SubscriptionAssigned as SubscriptionAssigned, type context_SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOff, type context_SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOn, type context_SubscriptionCancelled as SubscriptionCancelled, type context_SubscriptionCreated as SubscriptionCreated, type context_SubscriptionEvent as SubscriptionEvent, type context_SubscriptionEventEventOneOf as SubscriptionEventEventOneOf, type context_SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriod, type context_SubscriptionPendingChange as SubscriptionPendingChange, context_SubscriptionStatus as SubscriptionStatus, type context_SubscriptionTransferred as SubscriptionTransferred, type context_SubscriptionUnassigned as SubscriptionUnassigned, type context_Task as Task, type context_TaskAction as TaskAction, type context_TaskActionActionOneOf as TaskActionActionOneOf, type context_TaskKey as TaskKey, type context_UnassignProductInstanceFromSiteOptions as UnassignProductInstanceFromSiteOptions, type context_UnassignProductInstanceFromSiteRequest as UnassignProductInstanceFromSiteRequest, type context_UnassignProductInstanceFromSiteResponse as UnassignProductInstanceFromSiteResponse, type context_UnassignProductInstanceFromSiteResponseNonNullableFields as UnassignProductInstanceFromSiteResponseNonNullableFields, context_UnassignReason as UnassignReason, type context_UnassignedProductInstanceFromSite as UnassignedProductInstanceFromSite, type context_UpdatePackageExternalIdOptions as UpdatePackageExternalIdOptions, type context_UpdatePackageExternalIdRequest as UpdatePackageExternalIdRequest, type context_UpdatePackageExternalIdResponse as UpdatePackageExternalIdResponse, type context_UpdatePackageExternalIdResponseNonNullableFields as UpdatePackageExternalIdResponseNonNullableFields, type context_UpdateProductInstanceRequest as UpdateProductInstanceRequest, type context_UpdateProductInstanceResponse as UpdateProductInstanceResponse, context_WebhookIdentityType as WebhookIdentityType, context_adjustProductInstanceSpecifications as adjustProductInstanceSpecifications, context_assignProductInstanceToSite as assignProductInstanceToSite, context_cancelPackage as cancelPackage, context_cancelProductInstance as cancelProductInstance, context_createPackage as createPackage, context_createPackageV2 as createPackageV2, context_getPackage as getPackage, context_queryPackages as queryPackages, context_unassignProductInstanceFromSite as unassignProductInstanceFromSite, context_updatePackageExternalId as updatePackageExternalId };
 }
 
 export { context as packages };