@wix/auto_sdk_packages_packages 1.0.2 → 1.0.4

package/build/cjs/index.d.ts

@@ -1 +1,273 @@
-export * from './src/premium-reseller-v1-packages-packages.context.js';
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { C as CreatePackageOptions, a as CreatePackageResponse, b as CreatePackageV2Options, c as CancelPackageOptions, d as CancelPackageResponse, P as Package, e as PackagesQueryBuilder, A as AssignProductInstanceToSiteIdentifiers, f as AssignProductInstanceToSiteOptions, g as AssignProductInstanceToSiteResponse, U as UnassignProductInstanceFromSiteOptions, h as UnassignProductInstanceFromSiteResponse, i as CancelProductInstanceOptions, j as CancelProductInstanceResponse, k as AdjustProductInstanceSpecificationsOptions, l as AdjustProductInstanceSpecificationsResponse, m as UpdatePackageExternalIdIdentifiers, n as UpdatePackageExternalIdResponse } from './premium-reseller-v1-packages-packages.universal-CeJKqN8_.js';
+export { aR as ActionEvent, a6 as AdjustProductInstanceSpecificationsRequest, a7 as AdjustedProductInstanceSpecifications, a0 as AssignProductInstanceToSiteRequest, a1 as AssignedProductInstanceToSite, ac as BillingReference, aE as Cancel, K as CancelPackageRequest, a4 as CancelProductInstanceRequest, ak as CancellationDetails, aD as Complete, w as ContractSwitchReason, v as ContractSwitchType, aq as ContractSwitched, aJ as CountPackagesRequest, aK as CountPackagesResponse, J as CreatePackageRequest, Y as CursorPaging, $ as Cursors, ad as Cycle, ae as CycleCycleSelectorOneOf, o as CycleDescriptorType, E as CycleInterval, aL as DomainEvent, aM as DomainEventBodyOneOf, av as Empty, aN as EntityCreatedEvent, aQ as EntityDeletedEvent, aP as EntityUpdatedEvent, G as FailureReason, F as FailureReasonFailureReason, ax as FailureReportRequest, z as FieldToUpdate, aX as FixBrokenMigrationRequest, aY as FixBrokenMigrationResponse, M as GetPackageRequest, N as GetPackageResponse, aT as IdentificationData, aU as IdentificationDataIdOneOf, t as Initiator, af as Interval, I as IntervalIntervalUnit, r as IntervalUnit, aS as MessageEnvelope, aV as MigrateSubscriptionToPackagesRequest, aW as MigrateSubscriptionToPackagesResponse, ag as OneTime, L as PackageCanceled, aZ as PackagesQueryResult, X as Paging, _ as PagingMetadataV2, x as PriceIncreaseTrigger, y as ProductAdjustment, B as ProductInstance, a5 as ProductInstanceCanceled, D as ProductInstanceContractDetailsOneOf, H as ProductInstanceCycle, ay as ProductInstanceFailed, aw as ProductInstanceUpdated, ar as ProductPriceIncreaseData, q as ProviderName, Q as QueryPackagesRequest, Z as QueryPackagesResponse, O as QueryV2, T as QueryV2PagingMethodOneOf, ah as ReactivationData, R as ReactivationReasonEnum, au as RecurringChargeAttemptFailed, ap as RecurringChargeSucceeded, aF as Reschedule, aO as RestoreInfo, p as SortOrder, V as Sorting, S as Status, ab as Subscription, ai as SubscriptionAssigned, am as SubscriptionAutoRenewTurnedOff, al as SubscriptionAutoRenewTurnedOn, aj as SubscriptionCancelled, aa as SubscriptionCreated, a8 as SubscriptionEvent, a9 as SubscriptionEventEventOneOf, as as SubscriptionNearEndOfPeriod, at as SubscriptionPendingChange, s as SubscriptionStatus, ao as SubscriptionTransferred, an as SubscriptionUnassigned, az as Task, aB as TaskAction, aC as TaskActionActionOneOf, aA as TaskKey, a2 as UnassignProductInstanceFromSiteRequest, u as UnassignReason, a3 as UnassignedProductInstanceFromSite, aI as UpdatePackageExternalIdRequest, aG as UpdateProductInstanceRequest, aH as UpdateProductInstanceResponse, W as WebhookIdentityType } from './premium-reseller-v1-packages-packages.universal-CeJKqN8_.js';
+
+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>;
+}
+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>;
+}
+declare function cancelPackage$1(httpClient: HttpClient): CancelPackageSignature;
+interface CancelPackageSignature {
+    /**
+     * Cancels all product instances included in the package and the customer
+     * immediately loses 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>;
+}
+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.
+     * @returns Retrieved package.
+     */
+    (_id: string): Promise<Package>;
+}
+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.
+     */
+    (): PackagesQueryBuilder;
+}
+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>;
+}
+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>;
+}
+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 loses 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>;
+}
+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 losing 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>;
+}
+declare function updatePackageExternalId$1(httpClient: HttpClient): UpdatePackageExternalIdSignature;
+interface UpdatePackageExternalIdSignature {
+    /**
+     * Updates a package's external ID field.
+     */
+    (identifiers: UpdatePackageExternalIdIdentifiers): Promise<UpdatePackageExternalIdResponse>;
+}
+
+declare const createPackage: MaybeContext<BuildRESTFunction<typeof createPackage$1> & typeof createPackage$1>;
+declare const createPackageV2: MaybeContext<BuildRESTFunction<typeof createPackageV2$1> & typeof createPackageV2$1>;
+declare const cancelPackage: MaybeContext<BuildRESTFunction<typeof cancelPackage$1> & typeof cancelPackage$1>;
+declare const getPackage: MaybeContext<BuildRESTFunction<typeof getPackage$1> & typeof getPackage$1>;
+declare const queryPackages: MaybeContext<BuildRESTFunction<typeof queryPackages$1> & typeof queryPackages$1>;
+declare const assignProductInstanceToSite: MaybeContext<BuildRESTFunction<typeof assignProductInstanceToSite$1> & typeof assignProductInstanceToSite$1>;
+declare const unassignProductInstanceFromSite: MaybeContext<BuildRESTFunction<typeof unassignProductInstanceFromSite$1> & typeof unassignProductInstanceFromSite$1>;
+declare const cancelProductInstance: MaybeContext<BuildRESTFunction<typeof cancelProductInstance$1> & typeof cancelProductInstance$1>;
+declare const adjustProductInstanceSpecifications: MaybeContext<BuildRESTFunction<typeof adjustProductInstanceSpecifications$1> & typeof adjustProductInstanceSpecifications$1>;
+declare const updatePackageExternalId: MaybeContext<BuildRESTFunction<typeof updatePackageExternalId$1> & typeof updatePackageExternalId$1>;
+
+export { AdjustProductInstanceSpecificationsOptions, AdjustProductInstanceSpecificationsResponse, AssignProductInstanceToSiteIdentifiers, AssignProductInstanceToSiteOptions, AssignProductInstanceToSiteResponse, CancelPackageOptions, CancelPackageResponse, CancelProductInstanceOptions, CancelProductInstanceResponse, CreatePackageOptions, CreatePackageResponse, CreatePackageV2Options, Package, PackagesQueryBuilder, UnassignProductInstanceFromSiteOptions, UnassignProductInstanceFromSiteResponse, UpdatePackageExternalIdIdentifiers, UpdatePackageExternalIdResponse, adjustProductInstanceSpecifications, assignProductInstanceToSite, cancelPackage, cancelProductInstance, createPackage, createPackageV2, getPackage, queryPackages, unassignProductInstanceFromSite, updatePackageExternalId };