@wix/auto_sdk_packages_packages 1.0.18 → 1.0.20

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

@@ -1,3 +1,4 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
 import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 /**
@@ -1471,10 +1472,9 @@ interface FixBrokenMigrationResponse {
  * Required Fields:
  * - CreatePackageRequest.products
  *
- * Maturity: BETA
+ * Maturity: GA
  * Exposure: PUBLIC
  * @public
- * @documentationMaturity preview
  * @requiredField options.products
  * @permissionId premium.reseller-package.manage
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.CreatePackage
@@ -1531,7 +1531,6 @@ interface CreatePackageOptions {
  * > **Important**: This call requires an account level API key and cannot be
  * > authenticated with the standard authorization header.
  * @public
- * @documentationMaturity preview
  * @requiredField options.products
  * @requiredField options.products.countryCode
  * @permissionId premium.reseller-package.manage
@@ -1574,7 +1573,6 @@ interface CreatePackageV2Options {
  * > authenticated with the standard authorization header.
  * @param _id - ID of the package to cancel.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @permissionId premium.reseller-package.manage
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.CancelPackage
@@ -1599,7 +1597,6 @@ interface CancelPackageOptions {
  * > authenticated with the standard authorization header.
  * @param _id - Package ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @permissionId premium.reseller-package.read
  * @returns Retrieved package.
@@ -1644,9 +1641,6 @@ declare function getPackage(_id: string): Promise<NonNullablePaths<Package, `_id
  * 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),
@@ -1655,7 +1649,6 @@ declare function getPackage(_id: string): Promise<NonNullablePaths<Package, `_id
  * > **Important**: This call requires an account level API key and cannot be
  * > authenticated with the standard authorization header.
  * @public
- * @documentationMaturity preview
  * @permissionId premium.reseller-package.read
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.QueryPackages
  */
@@ -1674,15 +1667,10 @@ interface PackagesQueryResult extends QueryCursorResult {
     prev: () => Promise<PackagesQueryResult>;
 }
 interface PackagesQueryBuilder {
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
     limit: (limit: number) => PackagesQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
+    /** @param cursor - A pointer to specific record */
     skipTo: (cursor: string) => PackagesQueryBuilder;
-    /** @documentationMaturity preview */
     find: () => Promise<PackagesQueryResult>;
 }
 /**
@@ -1738,6 +1726,13 @@ type PackageQuery = {
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
     }[];
 };
+declare const utils: {
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<Package, PackageQuerySpec, PackageQuery>;
+        Filter: _wix_sdk_types.FilterFactory<Package, PackageQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<PackageQuerySpec>;
+    };
+};
 /**
  * Assigns a product instance to a site.
  *
@@ -1749,7 +1744,6 @@ type PackageQuery = {
  *
  * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
  * @public
- * @documentationMaturity preview
  * @requiredField identifiers
  * @requiredField identifiers.instanceId
  * @requiredField identifiers.siteId
@@ -1790,7 +1784,6 @@ interface AssignProductInstanceToSiteOptions {
  * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
  * @param instanceId - ID of the product instance to unassign from a site.
  * @public
- * @documentationMaturity preview
  * @requiredField instanceId
  * @permissionId premium.reseller-package.manage
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.UnassignProductInstanceFromSite
@@ -1825,7 +1818,6 @@ interface UnassignProductInstanceFromSiteOptions {
  * > authenticated with the standard authorization header.
  * @param instanceId - ID of the product instance to cancel.
  * @public
- * @documentationMaturity preview
  * @requiredField instanceId
  * @permissionId premium.reseller-package.manage
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.CancelProductInstance
@@ -1872,7 +1864,6 @@ interface CancelProductInstanceOptions {
  * > authenticated with the standard authorization header.
  * @param instanceId - ID of the product instance to adjust.
  * @public
- * @documentationMaturity preview
  * @requiredField instanceId
  * @permissionId premium.reseller-package.manage
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.AdjustProductInstanceSpecifications
@@ -1916,7 +1907,6 @@ interface AdjustProductInstanceSpecificationsOptions {
 /**
  * Updates a package's external ID field.
  * @public
- * @documentationMaturity preview
  * @requiredField identifiers
  * @requiredField identifiers.externalId
  * @requiredField identifiers.packageId
@@ -1937,4 +1927,4 @@ interface UpdatePackageExternalIdIdentifiers {
     externalId: string;
 }
 
-export { type AccountInfo, type ActionEvent, type AdjustProductInstanceSpecificationsOptions, type AdjustProductInstanceSpecificationsRequest, type AdjustProductInstanceSpecificationsResponse, type AdjustedProductInstanceSpecifications, type AssignProductInstanceToSiteIdentifiers, type AssignProductInstanceToSiteOptions, type AssignProductInstanceToSiteRequest, type AssignProductInstanceToSiteResponse, type AssignedProductInstanceToSite, type BillingReference, type Cancel, type CancelPackageOptions, type CancelPackageRequest, type CancelPackageResponse, type CancelProductInstanceOptions, type CancelProductInstanceRequest, type CancelProductInstanceResponse, type CancellationDetails, type CommonQueryWithEntityContext, type Complete, ContractSwitchReason, type ContractSwitchReasonWithLiterals, ContractSwitchType, type ContractSwitchTypeWithLiterals, type ContractSwitched, type CountPackagesRequest, type CountPackagesResponse, type CreatePackageOptions, type CreatePackageRequest, type CreatePackageResponse, type CreatePackageV2Options, type CursorPaging, type Cursors, type Cycle, type CycleCycleSelectorOneOf, CycleDescriptorType, type CycleDescriptorTypeWithLiterals, type CycleInterval, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailureReason, FailureReasonCode, type FailureReasonCodeWithLiterals, type FailureReportRequest, FieldToUpdate, type FieldToUpdateWithLiterals, type FixBrokenMigrationRequest, type FixBrokenMigrationResponse, type GetPackageRequest, type GetPackageResponse, type IdentificationData, type IdentificationDataIdOneOf, Initiator, type InitiatorWithLiterals, type Interval, IntervalIntervalUnit, type IntervalIntervalUnitWithLiterals, IntervalUnit, type IntervalUnitWithLiterals, type MessageEnvelope, type MigrateSubscriptionToPackagesRequest, type MigrateSubscriptionToPackagesResponse, type OneTime, type Package, type PackageCanceled, type PackageQuery, type PackageQuerySpec, type PackagesQueryBuilder, type PackagesQueryResult, type Paging, type PagingMetadataV2, PriceIncreaseTrigger, type PriceIncreaseTriggerWithLiterals, ProductAdjustment, type ProductAdjustmentWithLiterals, type ProductInstance, type ProductInstanceCanceled, type ProductInstanceContractDetailsOneOf, type ProductInstanceCycle, type ProductInstanceFailed, type ProductInstanceUpdated, type ProductPriceIncreaseData, ProviderName, type ProviderNameWithLiterals, type QueryPackagesRequest, type QueryPackagesResponse, type QueryV2, type QueryV2PagingMethodOneOf, type ReactivationData, ReactivationReasonEnum, type ReactivationReasonEnumWithLiterals, type RecurringChargeAttemptFailed, type RecurringChargeSucceeded, RefundType, type RefundTypeWithLiterals, type Reschedule, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type Subscription, type SubscriptionAssigned, type SubscriptionAutoRenewTurnedOff, type SubscriptionAutoRenewTurnedOn, type SubscriptionCancelled, type SubscriptionCreated, type SubscriptionEvent, type SubscriptionEventEventOneOf, type SubscriptionNearEndOfPeriod, type SubscriptionPendingChange, SubscriptionStatus, type SubscriptionStatusWithLiterals, type SubscriptionTransferred, type SubscriptionUnassigned, type Task, type TaskAction, type TaskActionActionOneOf, type TaskKey, type UnassignProductInstanceFromSiteOptions, type UnassignProductInstanceFromSiteRequest, type UnassignProductInstanceFromSiteResponse, UnassignReason, type UnassignReasonWithLiterals, type UnassignedProductInstanceFromSite, type UpdatePackageExternalIdIdentifiers, type UpdatePackageExternalIdRequest, type UpdatePackageExternalIdResponse, type UpdateProductInstanceRequest, type UpdateProductInstanceResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, adjustProductInstanceSpecifications, assignProductInstanceToSite, cancelPackage, cancelProductInstance, createPackage, createPackageV2, getPackage, queryPackages, typedQueryPackages, unassignProductInstanceFromSite, updatePackageExternalId };
+export { type AccountInfo, type ActionEvent, type AdjustProductInstanceSpecificationsOptions, type AdjustProductInstanceSpecificationsRequest, type AdjustProductInstanceSpecificationsResponse, type AdjustedProductInstanceSpecifications, type AssignProductInstanceToSiteIdentifiers, type AssignProductInstanceToSiteOptions, type AssignProductInstanceToSiteRequest, type AssignProductInstanceToSiteResponse, type AssignedProductInstanceToSite, type BillingReference, type Cancel, type CancelPackageOptions, type CancelPackageRequest, type CancelPackageResponse, type CancelProductInstanceOptions, type CancelProductInstanceRequest, type CancelProductInstanceResponse, type CancellationDetails, type CommonQueryWithEntityContext, type Complete, ContractSwitchReason, type ContractSwitchReasonWithLiterals, ContractSwitchType, type ContractSwitchTypeWithLiterals, type ContractSwitched, type CountPackagesRequest, type CountPackagesResponse, type CreatePackageOptions, type CreatePackageRequest, type CreatePackageResponse, type CreatePackageV2Options, type CursorPaging, type Cursors, type Cycle, type CycleCycleSelectorOneOf, CycleDescriptorType, type CycleDescriptorTypeWithLiterals, type CycleInterval, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailureReason, FailureReasonCode, type FailureReasonCodeWithLiterals, type FailureReportRequest, FieldToUpdate, type FieldToUpdateWithLiterals, type FixBrokenMigrationRequest, type FixBrokenMigrationResponse, type GetPackageRequest, type GetPackageResponse, type IdentificationData, type IdentificationDataIdOneOf, Initiator, type InitiatorWithLiterals, type Interval, IntervalIntervalUnit, type IntervalIntervalUnitWithLiterals, IntervalUnit, type IntervalUnitWithLiterals, type MessageEnvelope, type MigrateSubscriptionToPackagesRequest, type MigrateSubscriptionToPackagesResponse, type OneTime, type Package, type PackageCanceled, type PackageQuery, type PackageQuerySpec, type PackagesQueryBuilder, type PackagesQueryResult, type Paging, type PagingMetadataV2, PriceIncreaseTrigger, type PriceIncreaseTriggerWithLiterals, ProductAdjustment, type ProductAdjustmentWithLiterals, type ProductInstance, type ProductInstanceCanceled, type ProductInstanceContractDetailsOneOf, type ProductInstanceCycle, type ProductInstanceFailed, type ProductInstanceUpdated, type ProductPriceIncreaseData, ProviderName, type ProviderNameWithLiterals, type QueryPackagesRequest, type QueryPackagesResponse, type QueryV2, type QueryV2PagingMethodOneOf, type ReactivationData, ReactivationReasonEnum, type ReactivationReasonEnumWithLiterals, type RecurringChargeAttemptFailed, type RecurringChargeSucceeded, RefundType, type RefundTypeWithLiterals, type Reschedule, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type Subscription, type SubscriptionAssigned, type SubscriptionAutoRenewTurnedOff, type SubscriptionAutoRenewTurnedOn, type SubscriptionCancelled, type SubscriptionCreated, type SubscriptionEvent, type SubscriptionEventEventOneOf, type SubscriptionNearEndOfPeriod, type SubscriptionPendingChange, SubscriptionStatus, type SubscriptionStatusWithLiterals, type SubscriptionTransferred, type SubscriptionUnassigned, type Task, type TaskAction, type TaskActionActionOneOf, type TaskKey, type UnassignProductInstanceFromSiteOptions, type UnassignProductInstanceFromSiteRequest, type UnassignProductInstanceFromSiteResponse, UnassignReason, type UnassignReasonWithLiterals, type UnassignedProductInstanceFromSite, type UpdatePackageExternalIdIdentifiers, type UpdatePackageExternalIdRequest, type UpdatePackageExternalIdResponse, type UpdateProductInstanceRequest, type UpdateProductInstanceResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, adjustProductInstanceSpecifications, assignProductInstanceToSite, cancelPackage, cancelProductInstance, createPackage, createPackageV2, getPackage, queryPackages, typedQueryPackages, unassignProductInstanceFromSite, updatePackageExternalId, utils };

package/build/cjs/index.typings.js

@@ -48,7 +48,8 @@ __export(index_typings_exports, {
   queryPackages: () => queryPackages2,
   typedQueryPackages: () => typedQueryPackages,
   unassignProductInstanceFromSite: () => unassignProductInstanceFromSite2,
-  updatePackageExternalId: () => updatePackageExternalId2
+  updatePackageExternalId: () => updatePackageExternalId2,
+  utils: () => utils
 });
 module.exports = __toCommonJS(index_typings_exports);
 
@@ -432,6 +433,7 @@ function updatePackageExternalId(payload) {
 
 // src/premium-reseller-v1-packages-packages.universal.ts
 var import_transform_paths2 = require("@wix/sdk-runtime/transformations/transform-paths");
+var import_query_builder_utils = require("@wix/sdk-runtime/query-builder-utils");
 var FailureReasonCode = /* @__PURE__ */ ((FailureReasonCode2) => {
   FailureReasonCode2["UNKNOWN"] = "UNKNOWN";
   FailureReasonCode2["DELIVERY_TIMEOUT"] = "DELIVERY_TIMEOUT";
@@ -741,6 +743,11 @@ async function typedQueryPackages(query) {
     throw transformedError;
   }
 }
+var utils = {
+  query: {
+    ...(0, import_query_builder_utils.createQueryUtils)()
+  }
+};
 async function assignProductInstanceToSite2(identifiers, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -928,6 +935,7 @@ async function updatePackageExternalId2(identifiers) {
   queryPackages,
   typedQueryPackages,
   unassignProductInstanceFromSite,
-  updatePackageExternalId
+  updatePackageExternalId,
+  utils
 });
 //# sourceMappingURL=index.typings.js.map