@wix/auto_sdk_packages_packages 1.0.5 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
- import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
1
+ import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
2
2
  import { CreatePackageOptions, CreatePackageResponse, CreatePackageV2Options, CancelPackageOptions, CancelPackageResponse, Package, PackagesQueryBuilder, AssignProductInstanceToSiteIdentifiers, AssignProductInstanceToSiteOptions, AssignProductInstanceToSiteResponse, UnassignProductInstanceFromSiteOptions, UnassignProductInstanceFromSiteResponse, CancelProductInstanceOptions, CancelProductInstanceResponse, AdjustProductInstanceSpecificationsOptions, AdjustProductInstanceSpecificationsResponse, UpdatePackageExternalIdIdentifiers, UpdatePackageExternalIdResponse } from './index.typings.js';
3
- 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';
3
+ export { ActionEvent, AdjustProductInstanceSpecificationsRequest, AdjustedProductInstanceSpecifications, AssignProductInstanceToSiteRequest, AssignedProductInstanceToSite, BillingReference, Cancel, CancelPackageRequest, CancelProductInstanceRequest, CancellationDetails, Complete, ContractSwitchReason, ContractSwitchReasonWithLiterals, ContractSwitchType, ContractSwitchTypeWithLiterals, ContractSwitched, CountPackagesRequest, CountPackagesResponse, CreatePackageRequest, CursorPaging, Cursors, Cycle, CycleCycleSelectorOneOf, CycleDescriptorType, CycleDescriptorTypeWithLiterals, CycleInterval, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, FailureReason, FailureReasonFailureReason, FailureReasonFailureReasonWithLiterals, FailureReportRequest, FieldToUpdate, FieldToUpdateWithLiterals, FixBrokenMigrationRequest, FixBrokenMigrationResponse, GetPackageRequest, GetPackageResponse, IdentificationData, IdentificationDataIdOneOf, Initiator, InitiatorWithLiterals, Interval, IntervalIntervalUnit, IntervalIntervalUnitWithLiterals, IntervalUnit, IntervalUnitWithLiterals, MessageEnvelope, MigrateSubscriptionToPackagesRequest, MigrateSubscriptionToPackagesResponse, OneTime, PackageCanceled, PackagesQueryResult, Paging, PagingMetadataV2, PriceIncreaseTrigger, PriceIncreaseTriggerWithLiterals, ProductAdjustment, ProductAdjustmentWithLiterals, ProductInstance, ProductInstanceCanceled, ProductInstanceContractDetailsOneOf, ProductInstanceCycle, ProductInstanceFailed, ProductInstanceUpdated, ProductPriceIncreaseData, ProviderName, ProviderNameWithLiterals, QueryPackagesRequest, QueryPackagesResponse, QueryV2, QueryV2PagingMethodOneOf, ReactivationData, ReactivationReasonEnum, ReactivationReasonEnumWithLiterals, RecurringChargeAttemptFailed, RecurringChargeSucceeded, Reschedule, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, Status, StatusWithLiterals, Subscription, SubscriptionAssigned, SubscriptionAutoRenewTurnedOff, SubscriptionAutoRenewTurnedOn, SubscriptionCancelled, SubscriptionCreated, SubscriptionEvent, SubscriptionEventEventOneOf, SubscriptionNearEndOfPeriod, SubscriptionPendingChange, SubscriptionStatus, SubscriptionStatusWithLiterals, SubscriptionTransferred, SubscriptionUnassigned, Task, TaskAction, TaskActionActionOneOf, TaskKey, UnassignProductInstanceFromSiteRequest, UnassignReason, UnassignReasonWithLiterals, UnassignedProductInstanceFromSite, UpdatePackageExternalIdRequest, UpdateProductInstanceRequest, UpdateProductInstanceResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
4
4
 
5
5
  declare function createPackage$1(httpClient: HttpClient): CreatePackageSignature;
6
6
  interface CreatePackageSignature {
@@ -26,7 +26,7 @@ interface CreatePackageSignature {
26
26
  * Exposure: PUBLIC
27
27
  * @deprecated
28
28
  */
29
- (options?: CreatePackageOptions | undefined): Promise<CreatePackageResponse>;
29
+ (options?: NonNullablePaths<CreatePackageOptions, `products`, 2>): Promise<NonNullablePaths<CreatePackageResponse, `package._id` | `package.accountId` | `package.productInstances` | `package.productInstances.${number}.billingInfo.type` | `package.productInstances.${number}.billingInfo.cycleDuration.unit` | `package.productInstances.${number}.billingInfo.cycleDuration.count` | `package.productInstances.${number}.instanceId` | `package.productInstances.${number}.catalogProductId` | `package.productInstances.${number}.status` | `package.productInstances.${number}.failure.code` | `package.productInstances.${number}.failure.message`, 7>>;
30
30
  }
31
31
  declare function createPackageV2$1(httpClient: HttpClient): CreatePackageV2Signature;
32
32
  interface CreatePackageV2Signature {
@@ -60,7 +60,7 @@ interface CreatePackageV2Signature {
60
60
  * > **Important**: This call requires an account level API key and cannot be
61
61
  * > authenticated with the standard authorization header.
62
62
  */
63
- (options?: CreatePackageV2Options | undefined): Promise<CreatePackageResponse>;
63
+ (options?: NonNullablePaths<CreatePackageV2Options, `products` | `products.${number}.countryCode`, 4>): Promise<NonNullablePaths<CreatePackageResponse, `package._id` | `package.accountId` | `package.productInstances` | `package.productInstances.${number}.billingInfo.type` | `package.productInstances.${number}.billingInfo.cycleDuration.unit` | `package.productInstances.${number}.billingInfo.cycleDuration.count` | `package.productInstances.${number}.instanceId` | `package.productInstances.${number}.catalogProductId` | `package.productInstances.${number}.status` | `package.productInstances.${number}.failure.code` | `package.productInstances.${number}.failure.message`, 7>>;
64
64
  }
65
65
  declare function cancelPackage$1(httpClient: HttpClient): CancelPackageSignature;
66
66
  interface CancelPackageSignature {
@@ -82,7 +82,7 @@ interface CancelPackageSignature {
82
82
  * > authenticated with the standard authorization header.
83
83
  * @param - ID of the package to cancel.
84
84
  */
85
- (_id: string, options?: CancelPackageOptions | undefined): Promise<CancelPackageResponse>;
85
+ (_id: string, options?: CancelPackageOptions): Promise<NonNullablePaths<CancelPackageResponse, `package._id` | `package.accountId` | `package.productInstances` | `package.productInstances.${number}.billingInfo.type` | `package.productInstances.${number}.billingInfo.cycleDuration.unit` | `package.productInstances.${number}.billingInfo.cycleDuration.count` | `package.productInstances.${number}.instanceId` | `package.productInstances.${number}.catalogProductId` | `package.productInstances.${number}.status` | `package.productInstances.${number}.failure.code` | `package.productInstances.${number}.failure.message`, 7>>;
86
86
  }
87
87
  declare function getPackage$1(httpClient: HttpClient): GetPackageSignature;
88
88
  interface GetPackageSignature {
@@ -99,7 +99,7 @@ interface GetPackageSignature {
99
99
  * @param - Package ID.
100
100
  * @returns Retrieved package.
101
101
  */
102
- (_id: string): Promise<Package>;
102
+ (_id: string): Promise<NonNullablePaths<Package, `_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`, 6>>;
103
103
  }
104
104
  declare function queryPackages$1(httpClient: HttpClient): QueryPackagesSignature;
105
105
  interface QueryPackagesSignature {
@@ -167,7 +167,7 @@ interface AssignProductInstanceToSiteSignature {
167
167
  *
168
168
  * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
169
169
  */
170
- (identifiers: AssignProductInstanceToSiteIdentifiers, options?: AssignProductInstanceToSiteOptions | undefined): Promise<AssignProductInstanceToSiteResponse>;
170
+ (identifiers: NonNullablePaths<AssignProductInstanceToSiteIdentifiers, `instanceId` | `siteId`, 2>, options?: AssignProductInstanceToSiteOptions): Promise<NonNullablePaths<AssignProductInstanceToSiteResponse, `package._id` | `package.accountId` | `package.productInstances` | `package.productInstances.${number}.billingInfo.type` | `package.productInstances.${number}.billingInfo.cycleDuration.unit` | `package.productInstances.${number}.billingInfo.cycleDuration.count` | `package.productInstances.${number}.instanceId` | `package.productInstances.${number}.catalogProductId` | `package.productInstances.${number}.status` | `package.productInstances.${number}.failure.code` | `package.productInstances.${number}.failure.message`, 7>>;
171
171
  }
172
172
  declare function unassignProductInstanceFromSite$1(httpClient: HttpClient): UnassignProductInstanceFromSiteSignature;
173
173
  interface UnassignProductInstanceFromSiteSignature {
@@ -185,7 +185,7 @@ interface UnassignProductInstanceFromSiteSignature {
185
185
  * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
186
186
  * @param - ID of the product instance to unassign from a site.
187
187
  */
188
- (instanceId: string, options?: UnassignProductInstanceFromSiteOptions | undefined): Promise<UnassignProductInstanceFromSiteResponse>;
188
+ (instanceId: string, options?: UnassignProductInstanceFromSiteOptions): Promise<NonNullablePaths<UnassignProductInstanceFromSiteResponse, `package._id` | `package.accountId` | `package.productInstances` | `package.productInstances.${number}.billingInfo.type` | `package.productInstances.${number}.billingInfo.cycleDuration.unit` | `package.productInstances.${number}.billingInfo.cycleDuration.count` | `package.productInstances.${number}.instanceId` | `package.productInstances.${number}.catalogProductId` | `package.productInstances.${number}.status` | `package.productInstances.${number}.failure.code` | `package.productInstances.${number}.failure.message`, 7>>;
189
189
  }
190
190
  declare function cancelProductInstance$1(httpClient: HttpClient): CancelProductInstanceSignature;
191
191
  interface CancelProductInstanceSignature {
@@ -211,7 +211,7 @@ interface CancelProductInstanceSignature {
211
211
  * > authenticated with the standard authorization header.
212
212
  * @param - ID of the product instance to cancel.
213
213
  */
214
- (instanceId: string, options?: CancelProductInstanceOptions | undefined): Promise<CancelProductInstanceResponse>;
214
+ (instanceId: string, options?: CancelProductInstanceOptions): Promise<NonNullablePaths<CancelProductInstanceResponse, `package._id` | `package.accountId` | `package.productInstances` | `package.productInstances.${number}.billingInfo.type` | `package.productInstances.${number}.billingInfo.cycleDuration.unit` | `package.productInstances.${number}.billingInfo.cycleDuration.count` | `package.productInstances.${number}.instanceId` | `package.productInstances.${number}.catalogProductId` | `package.productInstances.${number}.status` | `package.productInstances.${number}.failure.code` | `package.productInstances.${number}.failure.message`, 7>>;
215
215
  }
216
216
  declare function adjustProductInstanceSpecifications$1(httpClient: HttpClient): AdjustProductInstanceSpecificationsSignature;
217
217
  interface AdjustProductInstanceSpecificationsSignature {
@@ -249,14 +249,14 @@ interface AdjustProductInstanceSpecificationsSignature {
249
249
  * > authenticated with the standard authorization header.
250
250
  * @param - ID of the product instance to adjust.
251
251
  */
252
- (instanceId: string, options?: AdjustProductInstanceSpecificationsOptions | undefined): Promise<AdjustProductInstanceSpecificationsResponse>;
252
+ (instanceId: string, options?: AdjustProductInstanceSpecificationsOptions): Promise<NonNullablePaths<AdjustProductInstanceSpecificationsResponse, `package._id` | `package.accountId` | `package.productInstances` | `package.productInstances.${number}.billingInfo.type` | `package.productInstances.${number}.billingInfo.cycleDuration.unit` | `package.productInstances.${number}.billingInfo.cycleDuration.count` | `package.productInstances.${number}.instanceId` | `package.productInstances.${number}.catalogProductId` | `package.productInstances.${number}.status` | `package.productInstances.${number}.failure.code` | `package.productInstances.${number}.failure.message`, 7>>;
253
253
  }
254
254
  declare function updatePackageExternalId$1(httpClient: HttpClient): UpdatePackageExternalIdSignature;
255
255
  interface UpdatePackageExternalIdSignature {
256
256
  /**
257
257
  * Updates a package's external ID field.
258
258
  */
259
- (identifiers: UpdatePackageExternalIdIdentifiers): Promise<UpdatePackageExternalIdResponse>;
259
+ (identifiers: NonNullablePaths<UpdatePackageExternalIdIdentifiers, `externalId` | `packageId`, 2>): Promise<NonNullablePaths<UpdatePackageExternalIdResponse, `updatedPackage._id` | `updatedPackage.accountId` | `updatedPackage.productInstances` | `updatedPackage.productInstances.${number}.billingInfo.type` | `updatedPackage.productInstances.${number}.billingInfo.cycleDuration.unit` | `updatedPackage.productInstances.${number}.billingInfo.cycleDuration.count` | `updatedPackage.productInstances.${number}.instanceId` | `updatedPackage.productInstances.${number}.catalogProductId` | `updatedPackage.productInstances.${number}.status` | `updatedPackage.productInstances.${number}.failure.code` | `updatedPackage.productInstances.${number}.failure.message`, 7>>;
260
260
  }
261
261
 
262
262
  declare const createPackage: MaybeContext<BuildRESTFunction<typeof createPackage$1> & typeof createPackage$1>;