@wix/auto_sdk_packages_packages 1.0.5 → 1.0.6

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

@@ -1,7 +1,8 @@
-import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
 import { CreatePackageOptions, CreatePackageResponse, CreatePackageV2Options, CancelPackageOptions, CancelPackageResponse, Package, PackagesQueryBuilder, AssignProductInstanceToSiteIdentifiers, AssignProductInstanceToSiteOptions, AssignProductInstanceToSiteResponse, UnassignProductInstanceFromSiteOptions, UnassignProductInstanceFromSiteResponse, CancelProductInstanceOptions, CancelProductInstanceResponse, AdjustProductInstanceSpecificationsOptions, AdjustProductInstanceSpecificationsResponse, UpdatePackageExternalIdIdentifiers, UpdatePackageExternalIdResponse } from './index.typings.js';
 export { ActionEvent, AdjustProductInstanceSpecificationsRequest, AdjustedProductInstanceSpecifications, AssignProductInstanceToSiteRequest, AssignedProductInstanceToSite, BillingReference, Cancel, CancelPackageRequest, CancelProductInstanceRequest, CancellationDetails, Complete, ContractSwitchReason, ContractSwitchType, ContractSwitched, CountPackagesRequest, CountPackagesResponse, CreatePackageRequest, CursorPaging, Cursors, Cycle, CycleCycleSelectorOneOf, CycleDescriptorType, CycleInterval, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, FailureReason, FailureReasonFailureReason, FailureReportRequest, FieldToUpdate, FixBrokenMigrationRequest, FixBrokenMigrationResponse, GetPackageRequest, GetPackageResponse, IdentificationData, IdentificationDataIdOneOf, Initiator, Interval, IntervalIntervalUnit, IntervalUnit, MessageEnvelope, MigrateSubscriptionToPackagesRequest, MigrateSubscriptionToPackagesResponse, OneTime, PackageCanceled, PackagesQueryResult, Paging, PagingMetadataV2, PriceIncreaseTrigger, ProductAdjustment, ProductInstance, ProductInstanceCanceled, ProductInstanceContractDetailsOneOf, ProductInstanceCycle, ProductInstanceFailed, ProductInstanceUpdated, ProductPriceIncreaseData, ProviderName, QueryPackagesRequest, QueryPackagesResponse, QueryV2, QueryV2PagingMethodOneOf, ReactivationData, ReactivationReasonEnum, RecurringChargeAttemptFailed, RecurringChargeSucceeded, Reschedule, RestoreInfo, SortOrder, Sorting, Status, Subscription, SubscriptionAssigned, SubscriptionAutoRenewTurnedOff, SubscriptionAutoRenewTurnedOn, SubscriptionCancelled, SubscriptionCreated, SubscriptionEvent, SubscriptionEventEventOneOf, SubscriptionNearEndOfPeriod, SubscriptionPendingChange, SubscriptionStatus, SubscriptionTransferred, SubscriptionUnassigned, Task, TaskAction, TaskActionActionOneOf, TaskKey, UnassignProductInstanceFromSiteRequest, UnassignReason, UnassignedProductInstanceFromSite, UpdatePackageExternalIdRequest, UpdateProductInstanceRequest, UpdateProductInstanceResponse, WebhookIdentityType } from './index.typings.js';
 
+type PackagesNonNullablePaths = `_id` | `accountId` | `productInstances` | `productInstances.${number}.billingInfo.type` | `productInstances.${number}.billingInfo.cycleDuration.unit` | `productInstances.${number}.billingInfo.cycleDuration.count` | `productInstances.${number}.instanceId` | `productInstances.${number}.catalogProductId` | `productInstances.${number}.status` | `productInstances.${number}.failure.code` | `productInstances.${number}.failure.message`;
 declare function createPackage$1(httpClient: HttpClient): CreatePackageSignature;
 interface CreatePackageSignature {
     /**
@@ -26,7 +27,9 @@ interface CreatePackageSignature {
      * Exposure: PUBLIC
      * @deprecated
      */
-    (options?: CreatePackageOptions | undefined): Promise<CreatePackageResponse>;
+    (options?: NonNullablePaths<CreatePackageOptions, `products`>): Promise<NonNullablePaths<CreatePackageResponse, {
+        [P in PackagesNonNullablePaths]: `package.${P}`;
+    }[PackagesNonNullablePaths]>>;
 }
 declare function createPackageV2$1(httpClient: HttpClient): CreatePackageV2Signature;
 interface CreatePackageV2Signature {
@@ -60,7 +63,9 @@ interface CreatePackageV2Signature {
      * > **Important**: This call requires an account level API key and cannot be
      * > authenticated with the standard authorization header.
      */
-    (options?: CreatePackageV2Options | undefined): Promise<CreatePackageResponse>;
+    (options?: NonNullablePaths<CreatePackageV2Options, `products` | `products.${number}.countryCode`>): Promise<NonNullablePaths<CreatePackageResponse, {
+        [P in PackagesNonNullablePaths]: `package.${P}`;
+    }[PackagesNonNullablePaths]>>;
 }
 declare function cancelPackage$1(httpClient: HttpClient): CancelPackageSignature;
 interface CancelPackageSignature {
@@ -82,7 +87,9 @@ interface CancelPackageSignature {
      * > authenticated with the standard authorization header.
      * @param - ID of the package to cancel.
      */
-    (_id: string, options?: CancelPackageOptions | undefined): Promise<CancelPackageResponse>;
+    (_id: string, options?: CancelPackageOptions): Promise<NonNullablePaths<CancelPackageResponse, {
+        [P in PackagesNonNullablePaths]: `package.${P}`;
+    }[PackagesNonNullablePaths]>>;
 }
 declare function getPackage$1(httpClient: HttpClient): GetPackageSignature;
 interface GetPackageSignature {
@@ -99,7 +106,7 @@ interface GetPackageSignature {
      * @param - Package ID.
      * @returns Retrieved package.
      */
-    (_id: string): Promise<Package>;
+    (_id: string): Promise<NonNullablePaths<Package, PackagesNonNullablePaths>>;
 }
 declare function queryPackages$1(httpClient: HttpClient): QueryPackagesSignature;
 interface QueryPackagesSignature {
@@ -167,7 +174,9 @@ interface AssignProductInstanceToSiteSignature {
      *
      * > **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>;
+    (identifiers: NonNullablePaths<AssignProductInstanceToSiteIdentifiers, `instanceId` | `siteId`>, options?: AssignProductInstanceToSiteOptions): Promise<NonNullablePaths<AssignProductInstanceToSiteResponse, {
+        [P in PackagesNonNullablePaths]: `package.${P}`;
+    }[PackagesNonNullablePaths]>>;
 }
 declare function unassignProductInstanceFromSite$1(httpClient: HttpClient): UnassignProductInstanceFromSiteSignature;
 interface UnassignProductInstanceFromSiteSignature {
@@ -185,7 +194,9 @@ interface UnassignProductInstanceFromSiteSignature {
      * > **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>;
+    (instanceId: string, options?: UnassignProductInstanceFromSiteOptions): Promise<NonNullablePaths<UnassignProductInstanceFromSiteResponse, {
+        [P in PackagesNonNullablePaths]: `package.${P}`;
+    }[PackagesNonNullablePaths]>>;
 }
 declare function cancelProductInstance$1(httpClient: HttpClient): CancelProductInstanceSignature;
 interface CancelProductInstanceSignature {
@@ -211,7 +222,9 @@ interface CancelProductInstanceSignature {
      * > authenticated with the standard authorization header.
      * @param - ID of the product instance to cancel.
      */
-    (instanceId: string, options?: CancelProductInstanceOptions | undefined): Promise<CancelProductInstanceResponse>;
+    (instanceId: string, options?: CancelProductInstanceOptions): Promise<NonNullablePaths<CancelProductInstanceResponse, {
+        [P in PackagesNonNullablePaths]: `package.${P}`;
+    }[PackagesNonNullablePaths]>>;
 }
 declare function adjustProductInstanceSpecifications$1(httpClient: HttpClient): AdjustProductInstanceSpecificationsSignature;
 interface AdjustProductInstanceSpecificationsSignature {
@@ -249,14 +262,18 @@ interface AdjustProductInstanceSpecificationsSignature {
      * > authenticated with the standard authorization header.
      * @param - ID of the product instance to adjust.
      */
-    (instanceId: string, options?: AdjustProductInstanceSpecificationsOptions | undefined): Promise<AdjustProductInstanceSpecificationsResponse>;
+    (instanceId: string, options?: AdjustProductInstanceSpecificationsOptions): Promise<NonNullablePaths<AdjustProductInstanceSpecificationsResponse, {
+        [P in PackagesNonNullablePaths]: `package.${P}`;
+    }[PackagesNonNullablePaths]>>;
 }
 declare function updatePackageExternalId$1(httpClient: HttpClient): UpdatePackageExternalIdSignature;
 interface UpdatePackageExternalIdSignature {
     /**
      * Updates a package's external ID field.
      */
-    (identifiers: UpdatePackageExternalIdIdentifiers): Promise<UpdatePackageExternalIdResponse>;
+    (identifiers: NonNullablePaths<UpdatePackageExternalIdIdentifiers, `externalId` | `packageId`>): Promise<NonNullablePaths<UpdatePackageExternalIdResponse, {
+        [P in PackagesNonNullablePaths]: `updatedPackage.${P}`;
+    }[PackagesNonNullablePaths]>>;
 }
 
 declare const createPackage: MaybeContext<BuildRESTFunction<typeof createPackage$1> & typeof createPackage$1>;