@wix/packages 1.0.9 → 1.0.11

package/build/cjs/index.d.ts

@@ -1 +1,2 @@
-export * as packages from '@wix/packages_packages';
+import * as packages from '@wix/packages_packages';
+export { packages };

package/build/cjs/index.js

@@ -24,5 +24,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.packages = void 0;
-exports.packages = __importStar(require("@wix/packages_packages"));
+const packages = __importStar(require("@wix/packages_packages"));
+exports.packages = packages;
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mEAAmD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AAE1C,4BAAQ"}

package/build/es/index.d.ts

@@ -1 +1,2 @@
-export * as packages from '@wix/packages_packages';
+import * as packages from '@wix/packages_packages';
+export { packages };

package/build/es/index.js

@@ -1,2 +1,3 @@
-export * as packages from '@wix/packages_packages';
+import * as packages from '@wix/packages_packages';
+export { packages };
 //# sourceMappingURL=index.js.map

package/build/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC;AAEnD,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/packages",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/packages_packages": "1.0.9"
+    "@wix/packages_packages": "1.0.11"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -27,8 +27,9 @@
     "typescript": "^5.3.2"
   },
   "scripts": {
-    "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
+    "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles && npm run build:validate-dts",
     "build:dts-bundles": "test -f config/rollup-config.js && NODE_OPTIONS=--max-old-space-size=8192 rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
+    "build:validate-dts": "tsc type-bundles/*.d.ts --noEmit",
     "test": ":"
   },
   "wix": {
@@ -42,5 +43,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "475e79d89e9089c555dea84a806cb2b3b4808865042f47aff8680f65"
+  "falconPackageHash": "8a3165c1dc4a72564b49210b90c58373171f6805b68dab07b5844e4e"
 }

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

@@ -1,3 +1,37 @@
+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>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 /**
  * A package is group of instances of Wix services that a reseller offers to a
  * customer as part of a single transaction.
@@ -10,7 +44,7 @@ interface Package {
     _id?: string;
     /**
      * Wix account ID. See
-     * [Account Level APIs](https://dev.wix.com/api/rest/account-level-apis/about-account-level-apis)
+     * [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis)
      * for more details.
      * @readonly
      */
@@ -248,17 +282,15 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
     /** 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 object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     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. */
@@ -1312,52 +1344,273 @@ interface UpdatePackageExternalIdIdentifiers {
     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>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+declare function createPackage$1(httpClient: HttpClient): CreatePackageSignature;
+interface CreatePackageSignature {
+    /**
+     * Creates a new package.
+     *
+     * Deprecated: This method is deprecated and will be removed by 2024-12-31.
+     * Use com.wixpress.premium.reseller.packages.v1.Packages.CreatePackageV2 instead.
+     *
+     * HTTP Request:
+     * POST /v1/packages
+     *
+     * Permissions:
+     * Requires the "premium.reseller-package.manage" permission with MANUAL type.
+     *
+     * Event:
+     * A PRIVATE callback will be triggered when the package is successfully created.
+     *
+     * Required Fields:
+     * - CreatePackageRequest.products
+     *
+     * Maturity: BETA
+     * Exposure: PUBLIC
+     * @deprecated
+     */
+    (options?: CreatePackageOptions | undefined): Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function createPackageV2$1(httpClient: HttpClient): CreatePackageV2Signature;
+interface CreatePackageV2Signature {
+    /**
+     * Creates a package of product instances.
+     *
+     *
+     * You must pass the relevant Wix account ID in the header of the call. In
+     * the DIY flow, we recommend to pass the customer's sub-account ID instead
+     * of your main reseller account ID.
+     *
+     * You may also pass a Wix site ID for each product in the body of the call.
+     * If you omit the site ID, a floating product instance is created.
+     *
+     * When Wix customers purchase a specific paid service or product, Wix may offer
+     * them time-limited free access to a different product. For example, customers
+     * get a voucher for a free 1-year domain registration when purchasing any Wix
+     * Premium plan. If you want to offer your customers the same benefit, create a
+     * package containing the original product first. Then, create a second package
+     * with the additional product. In the second Create Package call, pass the
+     * instance ID of the original product as `referenceProductInstanceId`. This way,
+     * Wix doesn't charge you for the additional product. Make sure that the status
+     * of the referenced product is either `"PENDING"` or `"ACTIVE"`. Note that you
+     * can use each product instance only a single time as reference instance.
+     *
+     * You need to pass a `countryCode` to specify where customers can claim
+     * vouchers that may come with a product. Contact the
+     * [Wix B2B sales team](mailto:bizdev@wix.com) to get information about
+     * vouchers and supported locations.
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     */
+    (options?: CreatePackageV2Options | undefined): Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
+}
+declare function cancelPackage$1(httpClient: HttpClient): CancelPackageSignature;
+interface CancelPackageSignature {
+    /**
+     * Cancels all product instances included in the package and the customer
+     * immediately looses access to the canceled functionality.
+     *
+     *
+     * You must pass the ID of the Wix account that the package belongs to in the
+     * header of the call. The call fails, if the package and Wix account don't
+     * match.
+     *
+     * If a canceled product instance is a requirement for another Wix service, that
+     * functionality is also no longer available to the customer. For example, if
+     * you cancel a Premium plan, a previously connected domain is automatically
+     * disconnected from the site.
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     * @param - ID of the package to cancel.
+     */
+    (_id: string, options?: CancelPackageOptions | undefined): Promise<CancelPackageResponse & CancelPackageResponseNonNullableFields>;
+}
+declare function getPackage$1(httpClient: HttpClient): GetPackageSignature;
+interface GetPackageSignature {
+    /**
+     * Retrieves a package.
+     *
+     *
+     * You must pass the ID of the Wix account that the package belongs to in the
+     * header of the call. The call fails, if the package and Wix account don't
+     * match.
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     * @param - Package ID.
+     */
+    (_id: string): Promise<GetPackageResponse & GetPackageResponseNonNullableFields>;
+}
+declare function queryPackages$1(httpClient: HttpClient): QueryPackagesSignature;
+interface QueryPackagesSignature {
+    /**
+     * Retrieves a list of packages, given the provided paging, filtering, and sorting.
+     *
+     *
+     * You must pass the ID of the Wix account that the packages belong to in the
+     * header of the call. The call returns packages that belong to the parent
+     * account, regardless if you pass the ID of a parent or sub-account. In case
+     * you want to retrieve only packages that belong to a sub-account, you must
+     * pass the sub-account ID as `filter` in the `query` object like this:
+     *
+     * ```json
+     * {
+     * "query": {
+     * "filter": {
+     * "accountId": {
+     * "$eq": "<SUB_ACCOUNT_ID>"
+     * }
+     * }
+     * }
+     * }
+     * ```
+     *
+     * Query Packages runs with these defaults, which you can override:
+     *
+     * - `createdDate` is sorted in `DESC` order
+     * - `cursorPaging.limit` is `100`
+     *
+     * By default `pagingMetadata.cursors` are returned, unless you specifically pass
+     * `query.paging`.
+     *
+     * The maximum for `cursorPaging.limit` is `100`.
+     *
+     * If you pass a cursor token that you have received in a previous Query Package response,
+     * passing additional sort or filter information results in an invalid cursor
+     * error. Since the received cursor token already holds all the needed information
+     * for sort and filter. Changing the sort and filter properties during the span of
+     * a cursor query isn't supported. But you can provide a different limit.
+     *
+     * For field support for filters and sorting,
+     * see [Query Packages: Supported Filters and Sorting](https://dev.wix.com/api/rest/account-level-apis/resellers/supported-filters).
+     *
+     * To learn about working with _Query_ endpoints, see
+     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
+     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
+     * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     * @param - Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.
+     */
+    (query: QueryV2): Promise<QueryPackagesResponse & QueryPackagesResponseNonNullableFields>;
+}
+declare function assignProductInstanceToSite$1(httpClient: HttpClient): AssignProductInstanceToSiteSignature;
+interface AssignProductInstanceToSiteSignature {
+    /**
+     * Assigns a product instance to a site.
+     *
+     *  You must pass the ID of the Wix account that the product instance belongs to in the header of the call.
+     *
+     *  The customer immediately gains access to features included in the assigned service. It's up to the reseller to decide whether assigning a product instance affects the customer’s payment.
+     *
+     *  It's possible to assign a product instance that's already assigned to a site, to a different site without [unassigning](/packages/unassign-product-instance-from-site) it first. But if the call fails in such a situation, the product instance may either remain assigned to the original site or become unassigned. You can confirm the instance's status by [retrieving the relevant package](/packages/get-package).
+     *
+     * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+     */
+    (identifiers: AssignProductInstanceToSiteIdentifiers, options?: AssignProductInstanceToSiteOptions | undefined): Promise<AssignProductInstanceToSiteResponse & AssignProductInstanceToSiteResponseNonNullableFields>;
+}
+declare function unassignProductInstanceFromSite$1(httpClient: HttpClient): UnassignProductInstanceFromSiteSignature;
+interface UnassignProductInstanceFromSiteSignature {
+    /**
+     * Unassigns a product instance from a site.
+     *
+     *  You must pass the ID of the Wix account that the product instance belongs to in the header of the call.
+     *
+     *  The product instance becomes floating and the customer immediately looses access to features included in the unassigned service. It's up to the reseller to decide whether unassigning a product instance affects the customer’s payment.
+     *
+     *  If an unassigned product instance is a requirement for another service, that service may not be available to the customer any longer. For example, if you unassign a `Combo Plan` plan from a site, a previously connected domain is disconnected.
+     *
+     *  You can assign floating product instances to sites using the [Assign Product Instance to Site](/packages/assign-product-instance-to-site) method.
+     *
+     * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+     * @param - ID of the product instance to unassign from a site.
+     */
+    (instanceId: string, options?: UnassignProductInstanceFromSiteOptions | undefined): Promise<UnassignProductInstanceFromSiteResponse & UnassignProductInstanceFromSiteResponseNonNullableFields>;
+}
+declare function cancelProductInstance$1(httpClient: HttpClient): CancelProductInstanceSignature;
+interface CancelProductInstanceSignature {
+    /**
+     * Cancels a product instance.
+     *
+     *
+     * You must pass the ID of the Wix account that the product instance belongs
+     * to in the header of the call. The call fails, if the product instance and
+     * Wix account don't match.
+     *
+     * The customer immediately looses access to features included in the
+     * canceled service. It's up to the reseller to decide whether the adjustment
+     * affects the customer’s payment.
+     *
+     * If a canceled service is a requirement for another service, that service
+     * may not be available to the customer any longer. For example, if you cancel
+     * a `Combo Plan` plan, a previously connected domain is disconnected
+     * from the site.
+     *
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     * @param - ID of the product instance to cancel.
+     */
+    (instanceId: string, options?: CancelProductInstanceOptions | undefined): Promise<CancelProductInstanceResponse & CancelProductInstanceResponseNonNullableFields>;
+}
+declare function adjustProductInstanceSpecifications$1(httpClient: HttpClient): AdjustProductInstanceSpecificationsSignature;
+interface AdjustProductInstanceSpecificationsSignature {
+    /**
+     * Upgrades or downgrades a product instance. For example, you can upgrade a
+     * customer's `Business Unlimited Premium` plan to `Business VIP` using this
+     * endpoint.
+     *
+     *
+     * You must pass the ID of the Wix account that the product instance belongs
+     * to in the header of the call. The call fails, if the product instance and
+     * Wix account don't match.
+     *
+     * The customer has immediate access to new features, while loosing access to
+     * features not included in the new service. It's up to the reseller to
+     * decide whether the adjustment affects the customer’s payment.
+     *
+     * You can only exchange a product instance with a service of the same type.
+     * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for details about
+     * which services belong to the same type.
+     *
+     * You must provide either a new `catalogProductId` or a new `billingInfo`
+     * object. The new billing cycle must be supported for the product. Contact the
+     * [Wix B2B sales team](mailto:bizdev@wix.com) for information
+     * about which billing cycles are supported for each product. If you adjust the
+     * billing cycle for a product instance with `RECURRING` payments, you must
+     * also provide `billingInfo.cycleDuration.unit`.
+     *
+     * If a removed feature is a requirement for another service, that service
+     * may not be available to the customer any longer. For example, if you downgrade a
+     * `Business Unlimited` plan to `Business Basic`, the site owners won’t be
+     * able to use `Pro eCommerce Features` any longer.
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     * @param - ID of the product instance to adjust.
+     */
+    (instanceId: string, options?: AdjustProductInstanceSpecificationsOptions | undefined): Promise<AdjustProductInstanceSpecificationsResponse & AdjustProductInstanceSpecificationsResponseNonNullableFields>;
+}
+declare function updatePackageExternalId$1(httpClient: HttpClient): UpdatePackageExternalIdSignature;
+interface UpdatePackageExternalIdSignature {
+    /**
+     * Updates a package's external ID field.
+     */
+    (identifiers: UpdatePackageExternalIdIdentifiers): Promise<UpdatePackageExternalIdResponse & UpdatePackageExternalIdResponseNonNullableFields>;
 }
 
-declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
-
-declare const createPackage: ReturnType<typeof createRESTModule<typeof publicCreatePackage>>;
-declare const createPackageV2: ReturnType<typeof createRESTModule<typeof publicCreatePackageV2>>;
-declare const cancelPackage: ReturnType<typeof createRESTModule<typeof publicCancelPackage>>;
-declare const getPackage: ReturnType<typeof createRESTModule<typeof publicGetPackage>>;
-declare const queryPackages: ReturnType<typeof createRESTModule<typeof publicQueryPackages>>;
-declare const assignProductInstanceToSite: ReturnType<typeof createRESTModule<typeof publicAssignProductInstanceToSite>>;
-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 updatePackageExternalId: ReturnType<typeof createRESTModule<typeof publicUpdatePackageExternalId>>;
+declare const createPackage: BuildRESTFunction<typeof createPackage$1> & typeof createPackage$1;
+declare const createPackageV2: BuildRESTFunction<typeof createPackageV2$1> & typeof createPackageV2$1;
+declare const cancelPackage: BuildRESTFunction<typeof cancelPackage$1> & typeof cancelPackage$1;
+declare const getPackage: BuildRESTFunction<typeof getPackage$1> & typeof getPackage$1;
+declare const queryPackages: BuildRESTFunction<typeof queryPackages$1> & typeof queryPackages$1;
+declare const assignProductInstanceToSite: BuildRESTFunction<typeof assignProductInstanceToSite$1> & typeof assignProductInstanceToSite$1;
+declare const unassignProductInstanceFromSite: BuildRESTFunction<typeof unassignProductInstanceFromSite$1> & typeof unassignProductInstanceFromSite$1;
+declare const cancelProductInstance: BuildRESTFunction<typeof cancelProductInstance$1> & typeof cancelProductInstance$1;
+declare const adjustProductInstanceSpecifications: BuildRESTFunction<typeof adjustProductInstanceSpecifications$1> & typeof adjustProductInstanceSpecifications$1;
+declare const updatePackageExternalId: BuildRESTFunction<typeof updatePackageExternalId$1> & typeof updatePackageExternalId$1;
 
 type context_ActionEvent = ActionEvent;
 type context_AdjustProductInstanceSpecificationsOptions = AdjustProductInstanceSpecificationsOptions;

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

@@ -1,3 +1,37 @@
+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>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 /**
  * A package is group of instances of Wix services that a reseller offers to a
  * customer as part of a single transaction.
@@ -10,7 +44,7 @@ interface Package {
     _id?: string;
     /**
      * Wix account ID. See
-     * [Account Level APIs](https://dev.wix.com/api/rest/account-level-apis/about-account-level-apis)
+     * [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis)
      * for more details.
      * @readonly
      */
@@ -248,17 +282,15 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
     /** 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 object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     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. */
@@ -1312,52 +1344,273 @@ interface UpdatePackageExternalIdIdentifiers {
     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>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+declare function createPackage$1(httpClient: HttpClient): CreatePackageSignature;
+interface CreatePackageSignature {
+    /**
+     * Creates a new package.
+     *
+     * Deprecated: This method is deprecated and will be removed by 2024-12-31.
+     * Use com.wixpress.premium.reseller.packages.v1.Packages.CreatePackageV2 instead.
+     *
+     * HTTP Request:
+     * POST /v1/packages
+     *
+     * Permissions:
+     * Requires the "premium.reseller-package.manage" permission with MANUAL type.
+     *
+     * Event:
+     * A PRIVATE callback will be triggered when the package is successfully created.
+     *
+     * Required Fields:
+     * - CreatePackageRequest.products
+     *
+     * Maturity: BETA
+     * Exposure: PUBLIC
+     * @deprecated
+     */
+    (options?: CreatePackageOptions | undefined): Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function createPackageV2$1(httpClient: HttpClient): CreatePackageV2Signature;
+interface CreatePackageV2Signature {
+    /**
+     * Creates a package of product instances.
+     *
+     *
+     * You must pass the relevant Wix account ID in the header of the call. In
+     * the DIY flow, we recommend to pass the customer's sub-account ID instead
+     * of your main reseller account ID.
+     *
+     * You may also pass a Wix site ID for each product in the body of the call.
+     * If you omit the site ID, a floating product instance is created.
+     *
+     * When Wix customers purchase a specific paid service or product, Wix may offer
+     * them time-limited free access to a different product. For example, customers
+     * get a voucher for a free 1-year domain registration when purchasing any Wix
+     * Premium plan. If you want to offer your customers the same benefit, create a
+     * package containing the original product first. Then, create a second package
+     * with the additional product. In the second Create Package call, pass the
+     * instance ID of the original product as `referenceProductInstanceId`. This way,
+     * Wix doesn't charge you for the additional product. Make sure that the status
+     * of the referenced product is either `"PENDING"` or `"ACTIVE"`. Note that you
+     * can use each product instance only a single time as reference instance.
+     *
+     * You need to pass a `countryCode` to specify where customers can claim
+     * vouchers that may come with a product. Contact the
+     * [Wix B2B sales team](mailto:bizdev@wix.com) to get information about
+     * vouchers and supported locations.
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     */
+    (options?: CreatePackageV2Options | undefined): Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
+}
+declare function cancelPackage$1(httpClient: HttpClient): CancelPackageSignature;
+interface CancelPackageSignature {
+    /**
+     * Cancels all product instances included in the package and the customer
+     * immediately looses access to the canceled functionality.
+     *
+     *
+     * You must pass the ID of the Wix account that the package belongs to in the
+     * header of the call. The call fails, if the package and Wix account don't
+     * match.
+     *
+     * If a canceled product instance is a requirement for another Wix service, that
+     * functionality is also no longer available to the customer. For example, if
+     * you cancel a Premium plan, a previously connected domain is automatically
+     * disconnected from the site.
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     * @param - ID of the package to cancel.
+     */
+    (_id: string, options?: CancelPackageOptions | undefined): Promise<CancelPackageResponse & CancelPackageResponseNonNullableFields>;
+}
+declare function getPackage$1(httpClient: HttpClient): GetPackageSignature;
+interface GetPackageSignature {
+    /**
+     * Retrieves a package.
+     *
+     *
+     * You must pass the ID of the Wix account that the package belongs to in the
+     * header of the call. The call fails, if the package and Wix account don't
+     * match.
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     * @param - Package ID.
+     */
+    (_id: string): Promise<GetPackageResponse & GetPackageResponseNonNullableFields>;
+}
+declare function queryPackages$1(httpClient: HttpClient): QueryPackagesSignature;
+interface QueryPackagesSignature {
+    /**
+     * Retrieves a list of packages, given the provided paging, filtering, and sorting.
+     *
+     *
+     * You must pass the ID of the Wix account that the packages belong to in the
+     * header of the call. The call returns packages that belong to the parent
+     * account, regardless if you pass the ID of a parent or sub-account. In case
+     * you want to retrieve only packages that belong to a sub-account, you must
+     * pass the sub-account ID as `filter` in the `query` object like this:
+     *
+     * ```json
+     * {
+     * "query": {
+     * "filter": {
+     * "accountId": {
+     * "$eq": "<SUB_ACCOUNT_ID>"
+     * }
+     * }
+     * }
+     * }
+     * ```
+     *
+     * Query Packages runs with these defaults, which you can override:
+     *
+     * - `createdDate` is sorted in `DESC` order
+     * - `cursorPaging.limit` is `100`
+     *
+     * By default `pagingMetadata.cursors` are returned, unless you specifically pass
+     * `query.paging`.
+     *
+     * The maximum for `cursorPaging.limit` is `100`.
+     *
+     * If you pass a cursor token that you have received in a previous Query Package response,
+     * passing additional sort or filter information results in an invalid cursor
+     * error. Since the received cursor token already holds all the needed information
+     * for sort and filter. Changing the sort and filter properties during the span of
+     * a cursor query isn't supported. But you can provide a different limit.
+     *
+     * For field support for filters and sorting,
+     * see [Query Packages: Supported Filters and Sorting](https://dev.wix.com/api/rest/account-level-apis/resellers/supported-filters).
+     *
+     * To learn about working with _Query_ endpoints, see
+     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
+     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
+     * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     * @param - Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.
+     */
+    (query: QueryV2): Promise<QueryPackagesResponse & QueryPackagesResponseNonNullableFields>;
+}
+declare function assignProductInstanceToSite$1(httpClient: HttpClient): AssignProductInstanceToSiteSignature;
+interface AssignProductInstanceToSiteSignature {
+    /**
+     * Assigns a product instance to a site.
+     *
+     *  You must pass the ID of the Wix account that the product instance belongs to in the header of the call.
+     *
+     *  The customer immediately gains access to features included in the assigned service. It's up to the reseller to decide whether assigning a product instance affects the customer’s payment.
+     *
+     *  It's possible to assign a product instance that's already assigned to a site, to a different site without [unassigning](/packages/unassign-product-instance-from-site) it first. But if the call fails in such a situation, the product instance may either remain assigned to the original site or become unassigned. You can confirm the instance's status by [retrieving the relevant package](/packages/get-package).
+     *
+     * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+     */
+    (identifiers: AssignProductInstanceToSiteIdentifiers, options?: AssignProductInstanceToSiteOptions | undefined): Promise<AssignProductInstanceToSiteResponse & AssignProductInstanceToSiteResponseNonNullableFields>;
+}
+declare function unassignProductInstanceFromSite$1(httpClient: HttpClient): UnassignProductInstanceFromSiteSignature;
+interface UnassignProductInstanceFromSiteSignature {
+    /**
+     * Unassigns a product instance from a site.
+     *
+     *  You must pass the ID of the Wix account that the product instance belongs to in the header of the call.
+     *
+     *  The product instance becomes floating and the customer immediately looses access to features included in the unassigned service. It's up to the reseller to decide whether unassigning a product instance affects the customer’s payment.
+     *
+     *  If an unassigned product instance is a requirement for another service, that service may not be available to the customer any longer. For example, if you unassign a `Combo Plan` plan from a site, a previously connected domain is disconnected.
+     *
+     *  You can assign floating product instances to sites using the [Assign Product Instance to Site](/packages/assign-product-instance-to-site) method.
+     *
+     * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+     * @param - ID of the product instance to unassign from a site.
+     */
+    (instanceId: string, options?: UnassignProductInstanceFromSiteOptions | undefined): Promise<UnassignProductInstanceFromSiteResponse & UnassignProductInstanceFromSiteResponseNonNullableFields>;
+}
+declare function cancelProductInstance$1(httpClient: HttpClient): CancelProductInstanceSignature;
+interface CancelProductInstanceSignature {
+    /**
+     * Cancels a product instance.
+     *
+     *
+     * You must pass the ID of the Wix account that the product instance belongs
+     * to in the header of the call. The call fails, if the product instance and
+     * Wix account don't match.
+     *
+     * The customer immediately looses access to features included in the
+     * canceled service. It's up to the reseller to decide whether the adjustment
+     * affects the customer’s payment.
+     *
+     * If a canceled service is a requirement for another service, that service
+     * may not be available to the customer any longer. For example, if you cancel
+     * a `Combo Plan` plan, a previously connected domain is disconnected
+     * from the site.
+     *
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     * @param - ID of the product instance to cancel.
+     */
+    (instanceId: string, options?: CancelProductInstanceOptions | undefined): Promise<CancelProductInstanceResponse & CancelProductInstanceResponseNonNullableFields>;
+}
+declare function adjustProductInstanceSpecifications$1(httpClient: HttpClient): AdjustProductInstanceSpecificationsSignature;
+interface AdjustProductInstanceSpecificationsSignature {
+    /**
+     * Upgrades or downgrades a product instance. For example, you can upgrade a
+     * customer's `Business Unlimited Premium` plan to `Business VIP` using this
+     * endpoint.
+     *
+     *
+     * You must pass the ID of the Wix account that the product instance belongs
+     * to in the header of the call. The call fails, if the product instance and
+     * Wix account don't match.
+     *
+     * The customer has immediate access to new features, while loosing access to
+     * features not included in the new service. It's up to the reseller to
+     * decide whether the adjustment affects the customer’s payment.
+     *
+     * You can only exchange a product instance with a service of the same type.
+     * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for details about
+     * which services belong to the same type.
+     *
+     * You must provide either a new `catalogProductId` or a new `billingInfo`
+     * object. The new billing cycle must be supported for the product. Contact the
+     * [Wix B2B sales team](mailto:bizdev@wix.com) for information
+     * about which billing cycles are supported for each product. If you adjust the
+     * billing cycle for a product instance with `RECURRING` payments, you must
+     * also provide `billingInfo.cycleDuration.unit`.
+     *
+     * If a removed feature is a requirement for another service, that service
+     * may not be available to the customer any longer. For example, if you downgrade a
+     * `Business Unlimited` plan to `Business Basic`, the site owners won’t be
+     * able to use `Pro eCommerce Features` any longer.
+     *
+     * > **Important**: This call requires an account level API key and cannot be
+     * > authenticated with the standard authorization header.
+     * @param - ID of the product instance to adjust.
+     */
+    (instanceId: string, options?: AdjustProductInstanceSpecificationsOptions | undefined): Promise<AdjustProductInstanceSpecificationsResponse & AdjustProductInstanceSpecificationsResponseNonNullableFields>;
+}
+declare function updatePackageExternalId$1(httpClient: HttpClient): UpdatePackageExternalIdSignature;
+interface UpdatePackageExternalIdSignature {
+    /**
+     * Updates a package's external ID field.
+     */
+    (identifiers: UpdatePackageExternalIdIdentifiers): Promise<UpdatePackageExternalIdResponse & UpdatePackageExternalIdResponseNonNullableFields>;
 }
 
-declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
-
-declare const createPackage: ReturnType<typeof createRESTModule<typeof publicCreatePackage>>;
-declare const createPackageV2: ReturnType<typeof createRESTModule<typeof publicCreatePackageV2>>;
-declare const cancelPackage: ReturnType<typeof createRESTModule<typeof publicCancelPackage>>;
-declare const getPackage: ReturnType<typeof createRESTModule<typeof publicGetPackage>>;
-declare const queryPackages: ReturnType<typeof createRESTModule<typeof publicQueryPackages>>;
-declare const assignProductInstanceToSite: ReturnType<typeof createRESTModule<typeof publicAssignProductInstanceToSite>>;
-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 updatePackageExternalId: ReturnType<typeof createRESTModule<typeof publicUpdatePackageExternalId>>;
+declare const createPackage: BuildRESTFunction<typeof createPackage$1> & typeof createPackage$1;
+declare const createPackageV2: BuildRESTFunction<typeof createPackageV2$1> & typeof createPackageV2$1;
+declare const cancelPackage: BuildRESTFunction<typeof cancelPackage$1> & typeof cancelPackage$1;
+declare const getPackage: BuildRESTFunction<typeof getPackage$1> & typeof getPackage$1;
+declare const queryPackages: BuildRESTFunction<typeof queryPackages$1> & typeof queryPackages$1;
+declare const assignProductInstanceToSite: BuildRESTFunction<typeof assignProductInstanceToSite$1> & typeof assignProductInstanceToSite$1;
+declare const unassignProductInstanceFromSite: BuildRESTFunction<typeof unassignProductInstanceFromSite$1> & typeof unassignProductInstanceFromSite$1;
+declare const cancelProductInstance: BuildRESTFunction<typeof cancelProductInstance$1> & typeof cancelProductInstance$1;
+declare const adjustProductInstanceSpecifications: BuildRESTFunction<typeof adjustProductInstanceSpecifications$1> & typeof adjustProductInstanceSpecifications$1;
+declare const updatePackageExternalId: BuildRESTFunction<typeof updatePackageExternalId$1> & typeof updatePackageExternalId$1;
 
 type index_d_ActionEvent = ActionEvent;
 type index_d_AdjustProductInstanceSpecificationsOptions = AdjustProductInstanceSpecificationsOptions;

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

@@ -10,7 +10,7 @@ interface Package$1 {
     id?: string;
     /**
      * Wix account ID. See
-     * [Account Level APIs](https://dev.wix.com/api/rest/account-level-apis/about-account-level-apis)
+     * [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis)
      * for more details.
      * @readonly
      */
@@ -233,17 +233,15 @@ interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
     /** 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$1;
     /**
-     * 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 object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting$1[];
     /** 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. */
@@ -464,7 +462,7 @@ interface Package {
     _id?: string;
     /**
      * Wix account ID. See
-     * [Account Level APIs](https://dev.wix.com/api/rest/account-level-apis/about-account-level-apis)
+     * [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis)
      * for more details.
      * @readonly
      */
@@ -687,17 +685,15 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
     /** 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 object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     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. */